Change File and Directory trait descriptions to take into account the 'exists' flag. #1440
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 customises the trait description for the
File
andDirectory
trait types to take into account whetherexists
was true or not.For the
File
trait, the description has changed from "a filename or object implementing the os.PathLike interface" to "a string or os.PathLike object" in the normal case and "a string or os.PathLike object referring to an existing file" for theFile(exists=True)
case. The changes forDirectory
are analogous.Before:
After:
Fixes #1439
@nicolasap-dm: Do you have bandwidth for a quick review?
Checklist
[ ] Update API reference (docs/source/traits_api_reference
) N/A[ ] Update User manual (docs/source/traits_user_manual
) N/A[ ] Update type annotation hints intraits-stubs
N/A