improve AbstractPipe docs and IOContext handling as an AbstractPipe #52768
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
1. Mention the expected API surface for AbstractPipe
2. Expand the docs for Pipe as well
3. And add better support for explicit type parameters to IOContext.
This gives more options to users, such as creating an explicitly
dynamic `IOContext{IO}(io)` to avoid excess specialization. Any
explicitly set parameter should now be inherited by future
`IOContext` constructions around it, rather than always directly
adopting the `typeof(io.io)` type instead as the new parameter.
vtjnash
force-pushed
the
jn/AbstractPipe-docs
branch
from
7e50591
to
649325b
Compare
vtjnash
added
the
status:merge me
IanButterworth
removed
the
status:merge me
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.
Following some complains that
AbstractPipedid not mention the functions that comprise its API, I have updated that and some other related details of its subtypes.IOContext{IO}(io)to avoid excess specialization. Any explicitly set parameter should now be inherited by futureIOContextconstructions around it, rather than always directly adopting thetypeof(io.io)type instead as the new parameter.