Do not check private functions for args, returns or raises #31
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
jdkandersson
reviewed
Nov 7, 2024
jdkandersson
approved these changes
Nov 7, 2024
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 removes the check for args, returns and raises in private methods starting with
_.Following PEP-8, Docstrings are not necessary for non-public methods. The docstring is still necessary (following the
but you should have a comment that describes what the method does).This PR excluded the checks for private functions/methods (starting with
_), but do not change the current process for functions starting with__(which are also private functions subject to name mangling). I have done that because those functions are not so common and also becausemagicfunctions also start with__(they also end with__, so we could differentiate them if necessary).