-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: simple docstring for write(filename::AbstractString, x)
#49835
Conversation
The distinction is important though - writing the binary representation of |
I see! Is it possible to link to the other method's documentation? I feel like it is important to keep this method's documentation accessible to people without a CS/math background. |
For linking other functions, it's usually done like this:
which will link to the documentation of
I'm not sure this is possible - we have to stop explaining at some point, otherwise docstrings get too long and miss their actual purpose, documenting what a given method does. For |
Co-authored-by: Jameson Nash <[email protected]>
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 :)
…efore `open` (#49837) Point 3 of #43428 Depends on #49835 and #49836 to be useful :) --------- Co-authored-by: Jameson Nash <[email protected]>
Point 2 of #43428.
I also changed "the canonical binary representation of a value" to just say "
x
".It felt like a very complex way of saying that it does what you think it does. 🙂 I think it's good to document it like this for the
write(io::IO, x)
method, but as I expressed in #43428, I think we should document thewrite(filename::String, content)
method in a more beginner-friendly way.