AbstractFilesystem: Add doc comments - #40
Merged
Merged
Conversation
Turbo87
commented
Jun 18, 2024
Comment on lines
+13
to
+14
| /// This method should return a [std::io::ErrorKind::NotFound] error if the | ||
| /// directory does not exist. |
Collaborator
Author
There was a problem hiding this comment.
I just discovered that the read_dir() call in the Filesystem impl also likes to return std::io::ErrorKind::NotADirectory in some cases. Unfortunately, that variant has been unstable for the past 3ish years so we can't actually produce it ourselves and neither can we match against it... 😩
Related:
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
2 participants
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
std::io::ErrorKind::NotFoundbehavior wasn't properly described previously, so this PR adds a couple of doc comments to the trait and impl.