Docs: simple docstring for read(filename::AbstractString)
#49836
Conversation
This file contains 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
This was referenced May 16, 2023
giordano
pushed a commit
that referenced
this pull request
Oct 31, 2023
Point 5 of #43428 Motivation: I feel like the most fundamental *file* operations in Julia are `read(filename::String)` and `write(filename::String, content)`, so it makes sense to repeat their documentation in the **Filesystem** documentation. I also see these methods as fundamental to teach beginners. Like #49837, the goal is to only show short docstrings for these methods, not the whole `IOStream` functionality. So it depends on #49835 and #49836 to be useful :)
giordano
pushed a commit
that referenced
this pull request
Nov 1, 2023
…efore `open` (#49837) Point 3 of #43428 Depends on #49835 and #49836 to be useful :) --------- Co-authored-by: Jameson Nash <[email protected]>
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.
As I expressed in #43428, I felt like the current documentation is not clear enough about the method
read(filename::AbstractString).In this PR I explicitly document this method on its own, without the
args...option. I suspect thatargs...is distracting (now users need to understandopenandread(io)before reading this docstring), and it might not be obvious that you can leaveargsempty.Feel free to edit this PR directly!