chore: use darglint to check if the docstrings match the actual implementation (DEV-2530) #453
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
jnussbaum
changed the title
DEV-2530 use darglint to check if the docstrings match the actual implementation
Sometimes, a parameter is forgotten in the docstrings. Darglint can find these. |
BalduinLandolt
approved these changes
Aug 14, 2023
| an xsd:ID based on the input string | ||
| an xsd ID based on the input string |
There was a problem hiding this comment.
IMO not necessarily an improvement, as the colon here suggests namespacing... but if the linter (or you, for that matter 🙂 ) prefers it, sure
Merged
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.
No description provided.