suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix {read,peek}-{byte,char}-or-special argument order

Browse Source
This commit is contained in:
Matthew Flatt 2017-06-29 13:15:43 -06:00
parent e289750b03
commit 7939e32a57
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkgs/racket-doc/scribblings/reference/custom-ports.scrbl
View File

@ -819,7 +819,7 @@ procedures.
arguments to the port's @racket[get-write-evt]. Some port
implementors, however, may choose not to provide
@racket[get-write-evt] (perhaps because writes cannot be
made atomic), or may implement @racket[write-proc] to
made atomic), or may implement @racket[write-out] to
enable a fast path for non-blocking writes or to
enable buffering.

32
pkgs/racket-doc/scribblings/reference/string-input.scrbl
View File

@ -367,8 +367,8 @@ with @racket[skip-bytes-amt] and @racket[progress] arguments like
@defproc[(read-char-or-special [in input-port? (current-input-port)]
[source-name any/c #f]
[special-wrap (or/c (any/c -> any/c) #f) #f])
[special-wrap (or/c (any/c -> any/c) #f) #f]
[source-name any/c #f])
(or/c char? eof-object? any/c)]{
Like @racket[read-char], but if the input port returns a
@ -379,19 +379,19 @@ then the result of applying @racket[special-wrap] to the
@tech{special} value is returned. A @racket[#f] value for
@racket[special-wrap] is treated the same as the identity function.
@history[#:changed "6.8.0.2" @elem{Added the @racket[source-name] and
@racket[special-wrap] arguments.}]}
@history[#:changed "6.8.0.2" @elem{Added the @racket[special-wrap] and
@racket[source-name] arguments.}]}
@defproc[(read-byte-or-special [in input-port? (current-input-port)]
[source-name any/c #f]
[special-wrap (or/c (any/c -> any/c) #f) #f])
[special-wrap (or/c (any/c -> any/c) #f) #f]
[source-name any/c #f])
(or/c byte? eof-object? any/c)]{
Like @racket[read-char-or-special], but reads and returns a byte
instead of a character.
@history[#:changed "6.8.0.2" @elem{Added the @racket[source-name] and
@racket[special-wrap] arguments.}]}
@history[#:changed "6.8.0.2" @elem{Added the @racket[special-wrap] and
@racket[source-name] arguments.}]}
@defproc[(peek-char [in input-port? (current-input-port)]
[skip-bytes-amt exact-nonnegative-integer? 0])
@ -410,29 +410,29 @@ character.}
@defproc[(peek-char-or-special [in input-port? (current-input-port)]
[skip-bytes-amt exact-nonnegative-integer? 0]
[source-name any/c #f]
[special-wrap (or/c (any/c -> any/c) #f) #f])
[special-wrap (or/c (any/c -> any/c) #f) #f]
[source-name any/c #f])
(or/c char? eof-object? any/c)]{
Like @racket[peek-char], but if the input port returns a non-byte
value after @racket[skip-bytes-amt] byte positions, then it is returned.
@history[#:changed "6.8.0.2" @elem{Added the @racket[source-name] and
@racket[special-wrap] arguments.}]}
@history[#:changed "6.8.0.2" @elem{Added the @racket[special-wrap] and
@racket[source-name] arguments.}]}
@defproc[(peek-byte-or-special [in input-port? (current-input-port)]
[skip-bytes-amt exact-nonnegative-integer? 0]
[progress (or/c progress-evt? #f) #f]
[source-name any/c #f]
[special-wrap (or/c (any/c -> any/c) #f) #f])
[special-wrap (or/c (any/c -> any/c) #f) #f]
[source-name any/c #f])
(or/c byte? eof-object? any/c)]{
Like @racket[peek-char-or-special], but @tech{peeks} and returns a byte
instead of a character, and it supports a @racket[progress] argument
like @racket[peek-bytes-avail!].
@history[#:changed "6.8.0.2" @elem{Added the @racket[source-name] and
@racket[special-wrap] arguments.}]}
@history[#:changed "6.8.0.2" @elem{Added the @racket[special-wrap] and
@racket[source-name] arguments.}]}
@defproc[(port-progress-evt [in (and/c input-port? port-provides-progress-evts?)