add missing docstrings to util and cli/_util functions#13987
Open
RavSinghChandan wants to merge 1 commit into
Open
add missing docstrings to util and cli/_util functions#13987RavSinghChandan wants to merge 1 commit into
RavSinghChandan wants to merge 1 commit into
Conversation
is_unconstrained_version, create_default_optimizer, check_lexeme_norms, raise_error, ignore_error in util.py and setup_cli in cli/_util.py were all missing docstrings
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Several public functions in
spacy/util.pyandspacy/cli/_util.pywere missing docstrings while the surrounding functions had them.Added docstrings following the existing spaCy style (
param (type): desc/RETURNS (type): desc) to:is_unconstrained_version— was the only function in the version-checking block without onecreate_default_optimizer— one-liner with no explanation of what it returnscheck_lexeme_norms— no description of its args or side effectsraise_error/ignore_error— error handler callbacks used as arguments elsewhere but undocumentedsetup_cli— entry point function with no docstringNo logic changed.