-
-
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
Fix #17070, move docs out of HelpDB too. #17763
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -168,11 +168,17 @@ General I/O | |
|
||
See ``read`` for a description of the ``all`` option. | ||
|
||
.. function:: read(stream::IO, nb=typemax(Int); all=true) | ||
.. function:: read(s::IO, nb=typemax(Int)) | ||
|
||
.. Docstring generated from Julia source | ||
|
||
Read at most ``nb`` bytes from ``stream``\ , returning a ``Vector{UInt8}`` of the bytes read. | ||
Read at most ``nb`` bytes from ``s``\ , returning a ``Vector{UInt8}`` of the bytes read. | ||
|
||
.. function:: read(s::IOStream, nb::Integer; all=true) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. later in
that still has the default value of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It doesn't have the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you can't, so maybe the signature with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree, will add. |
||
|
||
.. Docstring generated from Julia source | ||
|
||
Read at most ``nb`` bytes from ``s``\ , returning a ``Vector{UInt8}`` of the bytes read. | ||
|
||
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needs another make docs runno it doesn't i misread the diff below