Enable pydocstyle (D) ruff rule and add more docs #21
+104
−17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a ruff rule to catch missing documentation. Using google convention so that undocumented-param (D417) rule is enabled to catch missing params, xref https://docs.astral.sh/ruff/rules/undocumented-param. Extended to include D213 (instead of D212) and D410 rules too.
Also ignore rule D205 to allow first sentence of docstring to wrap to multiple lines.
weiji14
commented
Dec 8, 2025
Comment on lines
+25
to
+28
| Args: | ||
| buffer_size_km: Radius of the buffer in kilometres. | ||
| state: Pass in 'place' as state into this agent. | ||
| tool_call_id: Optional ID for tracking the tool call. |
Member
Author
There was a problem hiding this comment.
All arguments to public functions will now need to be documented to adhere to pydocstyle rule D417.
| [tool.ruff.lint.pydocstyle] | ||
| # See https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings | ||
| # for the enabled/disabled rules for the "google" convention. | ||
| convention = "google" |
Member
Author
There was a problem hiding this comment.
Using 'google' convention because that's the prevailing docstring type currently, and also because the D417 undocumented-param rule will be enforced.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Apply pydocstyle lint rule with the 'google' convention, then fix violations by adding more docstrings to public modules/classes/functions.
TODO:
References: