-
Notifications
You must be signed in to change notification settings - Fork 14
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
Conversation
Co-authored-by: Xiu-zhe (Roger) Luo <[email protected]>
There was a problem hiding this 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!
Co-authored-by: Xiu-zhe (Roger) Luo <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
There was a problem hiding this 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.
Co-authored-by: Xiu-zhe (Roger) Luo <[email protected]>
@Roger-luo, I have unrelated suggestion. I think it would be nice to have Live Reloading, huge convenience when seeing docs locally. Thoughts? |
There was a problem hiding this 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.
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) |
Fixes #957
Updated doc local preview
bloqade_doc_update.pdf