search

QuEraComputing / bloqade-python

QuEra's Neutral Atom SDK for Analog QPUs
https://bloqade.quera.com/
Other
54 stars 14 forks source link

[Unitary hack] Improve docstrings for "task/bloqade" #973

Closed shubhusion closed 2 months ago

shubhusion commented 4 months ago

Fixes #957

Improves Docstrings and Remove Markdown errors.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 89.90%. Comparing base (9fdc8cb) to head (67c53af).

:exclamation: Current head 67c53af differs from pull request most recent head e45d683

Please upload reports for the commit e45d683 to get more accurate results.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #973 +/- ## ======================================= Coverage 89.90% 89.90% ======================================= Files 110 110 Lines 8132 8132 ======================================= Hits 7311 7311 Misses 821 821 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

shubhusion commented 4 months ago

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 ?

Roger-luo commented 4 months ago

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.

shubhusion commented 4 months ago

@Roger-luo I have made changes in this PR as requested by you.