Add missing File::NotFoundError exception documentation for File.open
#15826
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
Co-authored-by: Johannes Müller <[email protected]>
Co-authored-by: Johannes Müller <[email protected]>
straight-shoota
approved these changes
May 27, 2025
Sija
suggested changes
May 30, 2025
| # | ||
| # ``` | ||
| # File.write("bar", "foo") | ||
| # File.read("bar") # => "foo" | ||
| # | ||
| # File.read("notexist") # raises File::NotFoundError |
There was a problem hiding this comment.
Suggested change
| # File.read("notexist") # raises File::NotFoundError | |
| # File.read("non-existent-file") # raises File::NotFoundError |
syeopite
reviewed
Jun 1, 2025
| @@ -524,10 +524,14 @@ class File < IO::FileDescriptor | |||
| end | |||
|
|
|||
| # Returns the content of *filename* as a string. | |||
| # | |||
| # Raises `File::NotFoundError` if the file at filename does not exist. | |||
There was a problem hiding this comment.
Wouldn't it be more accurate to say something around the lines of?
Raises
File::Errorif the file cannot be accessed for whatever reason.
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.
I think this is missing from the documentation. The PR is self explanatory (I believe)