Issue #609 - clarify what 'path contains a regular file' actually means #611
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.
The text of the
sftp.Client.MkdirAll
was found to be unclear as to what precisely “path contains a regular file” means. It means that if any path element in the chain of path elements is a regular file, that an error is returned. However, it could be mistakenly interpreted as “if any of the parent directories contains a regular file”. This new language is intended to exclude this possible reading.Resolves #609
The dev-v2 branch does not include such language, instead paralleling the
os.MkdirAll
language, which also does not explicitly call out this error condition.