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

Fix all numpydoc docstring warnings #547

Open
2 tasks done
andrewtavis opened this issue Jan 8, 2025 · 3 comments · Fixed by #552
Open
2 tasks done

Fix all numpydoc docstring warnings #547

andrewtavis opened this issue Jan 8, 2025 · 3 comments · Fixed by #552
Assignees
@MdSayemkhan
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@andrewtavis
Copy link
Member

Terms

Current Documentation

Now that we have the numpydoc pre-commit hook on the project thanks to #546, the next step is to fix the warnings that we have on all function/class docstrings in the project. There are many docstrings that have warnings that are shown by the hook.

The hook can be ran directly with:

pre-commit run numpydoc-validation --all-files

Suggested Enhancement

These warnings should be fixed as well as we can :) Happy to help with this and review!
@andrewtavis andrewtavis added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jan 8, 2025
MdSayemkhan added a commit to MdSayemkhan/Scribe-Data that referenced this issue Jan 19, 2025
@MdSayemkhan
fix: resolve numpydoc docstring warnings
264c4cc 
- Convert function summaries to infinitive verb form
- Fix parameter and return value descriptions
- Make docstrings more concise and accurate

Fixes scribe-org#547
@MdSayemkhan MdSayemkhan mentioned this issue Jan 19, 2025
Merged
2 tasks
andrewtavis added a commit that referenced this issue Jan 19, 2025
@andrewtavis
Merge pull request #552 from MdSayemkhan/issue#547
0989f03 
fix: resolve numpydoc docstring warnings #547
@github-project-automation github-project-automation bot moved this from Todo to Done in Scribe Board Jan 19, 2025
@andrewtavis andrewtavis reopened this Jan 19, 2025
@github-project-automation github-project-automation bot moved this from Done to In Progress in Scribe Board Jan 19, 2025
@andrewtavis
Copy link
Member Author

Hey @MdSayemkhan 👋 Let us know if you'd have interest in working on this further! We can do a couple of pull requests to fix all of this as it really is a lot for one PR. Then we can turn on the pre-commit hook at the end? Hope to work with you further on this!

@MdSayemkhan
Copy link
Contributor

Yes, I am interested to further work on this. Can you please assign me.

@andrewtavis
Copy link
Member Author

Assigned :) Thanks for your willingness to help here!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MdSayemkhan MdSayemkhan

Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
Scribe Board
Status: In Progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: resolve numpydoc docstring warnings #547 MdSayemkhan/Scribe-Data
2 participants
@andrewtavis @MdSayemkhan