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

Follow docstring guidelines/more descriptive docstrings #26

Open
dfieschko opened this issue Jan 5, 2022 · 0 comments
Open

Follow docstring guidelines/more descriptive docstrings #26

dfieschko opened this issue Jan 5, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dfieschko
Copy link
Owner

So far I've been writing docstrings for functions as just a few lines describing what the function does, but this is rather inconsistent. Docstrings should follow a standard of some sort instead. I'm leaning towards Google's python dosctring style.
@dfieschko dfieschko added cleanup documentation Improvements or additions to documentation and removed cleanup labels Jan 5, 2022
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
@dfieschko