Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Unitary-Hack][Task-Base] Docstring for "tasks/base" #970

Merged
merged 12 commits into from
Jun 3, 2024

Conversation

Manvi-Agrawal
Copy link
Contributor

@Manvi-Agrawal Manvi-Agrawal commented May 31, 2024

Fixes #957

Updated doc local preview
bloqade_doc_update.pdf

@Manvi-Agrawal Manvi-Agrawal mentioned this pull request May 31, 2024
3 tasks
src/bloqade/task/base.py Outdated Show resolved Hide resolved
src/bloqade/task/base.py Outdated Show resolved Hide resolved
src/bloqade/task/base.py Outdated Show resolved Hide resolved
Manvi-Agrawal and others added 3 commits May 31, 2024 11:40
@Manvi-Agrawal Manvi-Agrawal changed the title [Unitary hack] Docstring for "tasks/base" [Unitary-Hack][Task-Base] Docstring for "tasks/base" Jun 1, 2024
src/bloqade/task/base.py Outdated Show resolved Hide resolved
Copy link
Member

@Roger-luo Roger-luo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think except the example code style and the formatting issue @weinbe58 left other things look good to me. Please try to finish one PR first before opening more ones. That will create a lot of review work that is not necessary. Thank you!

src/bloqade/task/base.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jun 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.90%. Comparing base (0692d05) to head (e6c2414).
Report is 1 commits behind head on main.

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@Roger-luo Roger-luo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry I think there are only one last changes for the format. I think I go through more carefully this time.

Manvi-Agrawal and others added 2 commits June 3, 2024 13:05
Co-authored-by: Xiu-zhe (Roger) Luo <hiroger@qq.com>
@Manvi-Agrawal
Copy link
Contributor Author

@Roger-luo, I have unrelated suggestion. I think it would be nice to have Live Reloading, huge convenience when seeing docs locally. Thoughts?

Copy link
Member

@Roger-luo Roger-luo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good to merge. There are 8 docstrings being changed/added in this PR. While I may not want to recognize the one-liners counted but other docstrings are well written. So I think it's probably still fair to count this PR as a 32 USD bounty.

Just waiting CIs to pass.

@Roger-luo
Copy link
Member

I have unrelated suggestion. I think it would be nice to have Live Reloading, huge convenience when seeing docs locally. Thoughts?

It should be turned on at least for the main contents; I think because of how docstrings are generated, this might not be working properly. But I'm happy accepting PRs fixing that (It's not counted as part of unitary hack tho given it's not been listed)

@Roger-luo Roger-luo merged commit 777ef19 into QuEraComputing:main Jun 3, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

unitaryhack tracking issue by Manvi-Agrawal improve docstrings
3 participants