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

Include argument descriptions in all docstrings #151

Open
2 tasks
atteggiani opened this issue Nov 7, 2024 · 0 comments
Open
2 tasks

Include argument descriptions in all docstrings #151

atteggiani opened this issue Nov 7, 2024 · 0 comments

Comments

@atteggiani
Copy link
Collaborator

atteggiani commented Nov 7, 2024 •
edited
Loading

Currently argument descriptions are not present in all docstrings.
It is good practice to include this for code clarity (and potentially easier documentation).

  • Add argument descriptions in all docstrings
  • Remove D417 (undocumented-param) from the ignored rules in ruff.toml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@atteggiani