Skip to content

basic docstring coverage on methods #54

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.

Sign up for GitHub

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

Jump to bottom
Closed
Roger-luo opened this issue May 5, 2023 · 1 comment
Closed

basic docstring coverage on methods #54

Roger-luo opened this issue May 5, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone
public-alpha-3

Comments

@Roger-luo
Copy link
Member

right now the docstring is missing for most of the definitions, we should have some basic one-liner docstring to explain the functionality and also make them appear in the generated documentation.
@Roger-luo Roger-luo added the documentation Improvements or additions to documentation label May 5, 2023
@weinbe58 weinbe58 added this to the public-beta-1 milestone Aug 11, 2023
@Roger-luo
Copy link
Member Author

in dup of #945

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
public-alpha-3
Development

No branches or pull requests
2 participants
@Roger-luo @weinbe58