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.

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

Add docstrings for commonly used functions #3

Open
chinchien-lin opened this issue Aug 11, 2021 · 0 comments
Open

Add docstrings for commonly used functions #3

chinchien-lin opened this issue Aug 11, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@chinchien-lin
Copy link
Collaborator

Add docstrings to provide proper descriptions for all main/commonly used functions.
Docstrings can also be used in Sphinx documentation to automatically generate the API page.
@chinchien-lin chinchien-lin added the documentation Improvements or additions to documentation label Aug 11, 2021
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
No milestone
Development

No branches or pull requests
1 participant
@chinchien-lin