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

improve one-liner docstring #946

Closed
1 task
Tracked by #957
Roger-luo opened this issue May 15, 2024 · 0 comments
Closed
1 task
Tracked by #957

improve one-liner docstring #946

Roger-luo opened this issue May 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Roger-luo
Copy link
Member

Roger-luo commented May 15, 2024

While I don't like having an entire article in the docstring, some of our docstrings are too brief, and they are part of the hints - they only have one line. Let's keep a list of them to track progress.

@Roger-luo Roger-luo added the documentation Improvements or additions to documentation label May 15, 2024
@Roger-luo Roger-luo changed the title explain terms mentioned in one-liner docstrings improve one-liner docstring May 15, 2024
@Roger-luo Roger-luo mentioned this issue May 23, 2024
3 tasks
shubhusion added a commit to shubhusion/bloqade-python that referenced this issue May 25, 2024
shubhusion added a commit to shubhusion/bloqade-python that referenced this issue May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant