Improve docstring quality and consistency #326
Merged
Conversation
This file contains 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
flferretti
force-pushed
the
update_docstrings
branch
2 times, most recently
from
356a33d to
174fc48
Compare
xela-95
approved these changes
Jan 8, 2025
There was a problem hiding this comment.
Thanks @flferretti !! I think this could be useful to improve the codebase documentation, we shall just check if this linter is excessively pedantic and adjust the rules to ignore accordingly.
flferretti
force-pushed
the
update_docstrings
branch
3 times, most recently
from
ed27b29 to
0eefef5
Compare
|
@CarlottaSartore could you please check this when you have time? Thanks! |
CarlottaSartore
approved these changes
Jan 8, 2025
flferretti
force-pushed
the
update_docstrings
branch
from
0eefef5 to
3dca043
Compare
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.
This PR enhances clarity and uniformity of docstrings across the codebase by removing unnecessary type hints, adopting imperative mood, and adding missing documentation where needed. This update also introduces a
pydocstylecheck in theruffconfiguration to enforce these standards in the future.📚 Documentation preview 📚: https://jaxsim--326.org.readthedocs.build//326/