QuEraComputing / bloqade-python

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

[Unitary hack] Revert the long Docstring #966

Closed shubhusion closed 4 months ago

shubhusion commented 4 months ago

Fixes #954 #957 Improve Docstrings and Revert the long Docstrings

codecov[bot] commented 4 months ago

Codecov Report

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

Project coverage is 89.91%. Comparing base (aada63a) to head (2f7cb7f).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #966 +/- ## ======================================= Coverage 89.91% 89.91% ======================================= Files 110 110 Lines 8129 8129 ======================================= Hits 7309 7309 Misses 820 820 ```

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

shubhusion commented 4 months ago

Okay i will make changes. I was just following the function definition mentioned. So that it looks uniform

On Thu, 30 May, 2024, 23:37 Xiu-zhe (Roger) Luo, @.***> wrote:

@.**** commented on this pull request.

In src/bloqade/builder/coupling.py https://github.com/QuEraComputing/bloqade-python/pull/966#discussion_r1621196889 :

  • Raises:
  • None

if it raises None why do we need to mention it?

In src/bloqade/builder/coupling.py https://github.com/QuEraComputing/bloqade-python/pull/966#discussion_r1621227425 :

  • Raises:
  • None

why do we have raises here?

— Reply to this email directly, view it on GitHub https://github.com/QuEraComputing/bloqade-python/pull/966#pullrequestreview-2089009756, or unsubscribe https://github.com/notifications/unsubscribe-auth/AW6XHI6BPGUEH7PPEW6EY4TZE5TH5AVCNFSM6AAAAABIQVQHCCVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDAOBZGAYDSNZVGY . You are receiving this because you authored the thread.Message ID: @.***>

shubhusion commented 4 months ago

@Roger-luo @johnzl-777 As per the feedback provided , I have made the necessary changes.

Roger-luo commented 4 months ago

I'm good with this change; I think it can be counted as a 20 USD bounty.