BQSKit / bqskit

Berkeley Quantum Synthesis Toolkit
Other
106 stars 31 forks source link

Proposed Adjustment in the BQSKIT documentation #245

Open mwalidcharrwi opened 1 month ago

mwalidcharrwi commented 1 month ago

Hi,

I wanted to bring your kind notice into an update that could be done in the documentation for the Compiler.status(task_id): https://bqskit.readthedocs.io/en/latest/source/autogen/bqskit.compiler.Compiler.status.html#bqskit.compiler.Compiler.status

Where the return type values (CompilationStatus) would be mentioned under that function call in the documentation.