Document check_path_length to default to False
#1036
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
conda-bot
added
the
cla-signed
marcoesters
changed the title
check_path_length to default to False
2 tasks
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.
Description
The documentation states that
check_path_lengthdefaults toTrue. The code, however, indicates that the default value isNoneand has beenNonefor a long time. So, the default behavior isFalse.Correct the error in the documentation. Additionally, limit the type to
boolsince there is no special behavior forNone.Xref: #1022
Checklist - did you ...
newsdirectory (using the template) for the next release's release notes?