RFC: improve docs for IOContext. fixes #16763
#17545
Merged
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
|
cc @dpsanders do you think this is enough information for package authors to be able to use this effectively? |
|
Perhaps document the kwarg syntax too? |
StefanKarpinski
added
docs
JeffBezanson
force-pushed
the
jb/iocontextdoc
branch
from
13bc323 to
5dc55f3
Compare
|
@timholy Added, and also mentioned I'm cancelling CI since the non-doc part of the change already passed on a few platforms. |
|
I would suggest that we merge this and close the issue for now – there's nothing preventing further documentation improvements in the 0.5.x timeframe. It's time to get on with the release. |
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.
(also remove some references to the removed
multilineproperty)Suggestions welcome on what or where else to put in docs on this.