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 and lint them #10

Open
aazuspan opened this issue Apr 20, 2023 · 2 comments
Open

Add docstrings and lint them #10

aazuspan opened this issue Apr 20, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation dx Developer experience, tools, efficiency, etc.
Milestone
0.1.0

Comments

@aazuspan
Copy link
Contributor

aazuspan commented Apr 20, 2023 •
edited
Loading

We need to add docstrings for the public API, and probably the flake8-docstrings plugin to lint them once #8 is merged.

@grovduck Any preference on docstring conventions?
@aazuspan aazuspan added documentation Improvements or additions to documentation dx Developer experience, tools, efficiency, etc. labels Apr 20, 2023
@grovduck grovduck mentioned this issue Apr 21, 2023
Merged
@grovduck
Copy link
Member

@aazuspan, I've heavily used numpydoc in the past, but again open to whatever you've found that you like.

@aazuspan
Copy link
Contributor Author

Perfect, numpy is what I'm used to!

@aazuspan aazuspan added this to the 0.1.0 milestone May 31, 2023
@aazuspan aazuspan mentioned this issue Sep 29, 2023
Merged
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 dx Developer experience, tools, efficiency, etc.
Projects
None yet
Milestone
0.1.0
Development

No branches or pull requests
2 participants
@grovduck @aazuspan