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

Make docstrings uniform #14

Open
mee5-pdx opened this issue Sep 26, 2024 · 2 comments
Open

Make docstrings uniform #14

mee5-pdx opened this issue Sep 26, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@mee5-pdx
Copy link
Contributor

Many functions only take a few lines, so formatting docstrings like in the google docstring format may be nice

@mee5-pdx mee5-pdx added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Sep 26, 2024
@dankeg
Copy link

dankeg commented Oct 7, 2024

I'm interested in taking a crack at this, to clarify this would involve transitioning to this format across the repo?: https://gist.github.com/redlotus/3bc387c2591e3e908c9b63b97b11d24e

@mee5-pdx
Copy link
Contributor Author

mee5-pdx commented Oct 8, 2024

I'm interested in taking a crack at this, to clarify this would involve transitioning to this format across the repo?: https://gist.github.com/redlotus/3bc387c2591e3e908c9b63b97b11d24e

Yes, I was aiming to do a similar format to this. The docstrings from lines 67-75 is what I would prefer most docstrings to look like

  • A short summary/description
  • An args/parameters section (with types specified)
  • A returns section (with types specified)

See https://realpython.com/documenting-python-code/#docstring-formats
I generally disliked the numpy/scipy type docstrings because it basically doubles the number of lines.

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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants