[Unitary hack] Improve docstrings for "task/bloqade" #973
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #973 +/- ##
=======================================
Coverage 89.90% 89.90%
=======================================
Files 110 110
Lines 8132 8132
=======================================
Hits 7311 7311
Misses 821 821 ☔ View full report in Codecov by Sentry. |
shubhusion
changed the title
There was a problem hiding this comment.
I'd recommend to finish one of the PRs first instead of submitting a bunch of them to review, so you don't waste any effort and we don't need to review similar issues multiple times. The docstrings in tasks are harder to write as they are deeper in the codebase. I'd recommend you to go through some basic tutorial before going ahead so we make docstring friendly to new comers other than just plain explanation of what the code does.
@Roger-luo can you provide a link to tutorials which i can refer to ? |
|
https://queracomputing.github.io/bloqade-python-examples/latest/ you can also check the quick start guide in the documentation homepage to understand better what this package does. |
|
@Roger-luo I have made changes in this PR as requested by you. |
| shots: int | ||
| emulator_ir: EmulatorProgram | ||
| metadata: Dict[str, ParamType] | ||
| compile_cache: Optional[CompileCache] = None | ||
| task_result_ir: Optional[QuEraTaskResults] = None | ||
|
|
||
| def _geometry(self) -> Geometry: | ||
| """ |
| @@ -47,7 +83,22 @@ def run( | |||
| nsteps: int = 2_147_483_647, | |||
| interaction_picture: bool = False, | |||
| ) -> "BloqadeTask": | |||
|
|
|||
| """ | |||
There was a problem hiding this comment.
please also add one example to demonstrate how this function can be used. This is a user API.
Fixes #957
Improves Docstrings and Remove Markdown errors.