Fix #17070, move docs out of HelpDB too. #17763
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
kshyatt
added
docs
|
should mention what #17070 means in the commit message |
…t of HelpDB too. Fixed the type signatures. Made `nb` reflect what's actually in the code.
| @@ -168,11 +168,11 @@ General I/O | |||
|
|
|||
| See ``read`` for a description of the ``all`` option. | |||
|
|
|||
| .. function:: read(stream::IO, nb=typemax(Int); all=true) | |||
| .. function:: read(s::IOStream, nb::Integer; all=true) | |||
There was a problem hiding this comment.
later in base/io.jl there is
# read up to nb bytes from s, returning a Vector{UInt8} of bytes read.
function read(s::IO, nb=typemax(Int))
that still has the default value of nb
There was a problem hiding this comment.
It doesn't have the all kwarg though. You can't do read(s; all=false), can you?
There was a problem hiding this comment.
you can't, so maybe the signature with (s::IO, nb=typemax(Int)) default value but no kwarg should be a separate docstring?
|
Travis fail isn't my fault, right? |
| If `all` is `true` (the default), this function will block repeatedly trying to read all | ||
| requested bytes, until an error or end-of-file occurs. If `all` is `false`, at most one | ||
| `read` call is performed, and the amount of data returned is device-dependent. Note that not | ||
| all stream types support the `all` option. |
There was a problem hiding this comment.
needs another make docs run no it doesn't i misread the diff below
|
timeout, probably related to the perf regression |
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.
No description provided.