Add documentation for IO interface (rebased) #59069
Closed
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
- Change required methods to read/write/eof (basic byte operations) - Move unsafe_read/unsafe_write to optional methods for performance - Add comprehensive list of optional IO methods - Update description to clarify that byte read/write are fundamental - Explain unsafe methods are for high-performance scenarios - Clarify eof behavior and state query methods 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
laborg
reviewed
Jul 23, 2025
doc/src/manual/interfaces.md
Outdated
| These rules allow broadcasting to keep the sparse representation for operations that result | ||
| in one or two dimensional outputs, but produce an `Array` for any other dimensionality. | ||
|
|
||
| <<<<<<< HEAD |
ChrisRackauckas
commented
Jul 23, 2025
|
How does this relate to #58024? |
nsajko
added
docs
nhz2
reviewed
Jul 27, 2025
| | `isopen(io)` | Whether the IO stream is usable. | | ||
| | `isreadable(io)` | Whether the IO stream supports reading. | | ||
| | `iswritable(io)` | Whether the IO stream supports writing. | | ||
| | `shutdown(io)` | Close the stream for writing. | |
|
Not necessarily related? This was just doing the |
nsajko
added a commit
to nsajko/julia
that referenced
this pull request
Sep 21, 2025
The intention is to add just a minimal doc string. Other PRs attempt to document the interface, such as: * JuliaLang#41291 * JuliaLang#58024 * JuliaLang#59069
oscardssmith
pushed a commit
that referenced
this pull request
Sep 23, 2025
The intention is to add just a minimal doc string. Other PRs attempt to document the interface, such as: * #41291 * #58024 * #59069 --------- Co-authored-by: Jakob Nybo Nissen <[email protected]>
xal-0
pushed a commit
to xal-0/julia
that referenced
this pull request
Sep 30, 2025
The intention is to add just a minimal doc string. Other PRs attempt to document the interface, such as: * JuliaLang#41291 * JuliaLang#58024 * JuliaLang#59069 --------- Co-authored-by: Jakob Nybo Nissen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 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.
Summary
Background
This PR adds missing documentation for Julia's IO interface, helping developers understand how to implement custom IO types. The documentation covers the essential methods needed and provides practical examples.
Changes
🤖 Generated with Claude Code