Skip to content
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

Some documentation edits #4355

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion pkgs/racket-doc/scribblings/reference/port-lib.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ on @racket[in] until it produces @racket[eof].
string?]{

Reads all characters from @racket[in] and returns them as a string.
The input port is closed unless @racket[close?] is @racket[#f].
If @racket[close?] is @racket[#t], then the input port is closed,
otherwise, it is left open.

@examples[#:eval port-eval
(port->string (open-input-string "hello world"))
Expand Down
7 changes: 6 additions & 1 deletion pkgs/racket-doc/scribblings/reference/subprocess.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ explicitly closed, usually with @racket[close-input-port] or
@racket[close-output-port].

@margin-note{A @tech{file-stream port} for communicating with a
subprocess is normally a pipe with a limited capacity. Beware of
subprocess is normally a pipe with a limited buffer capacity. Beware of
creating deadlock by serializing a write to a subprocess followed by a
read, while the subprocess does the same, so that both processes end
up blocking on a write because the other end must first read to make
Expand Down Expand Up @@ -167,6 +167,9 @@ Example:
(subprocess-wait sp)
]

@; PLACEHOLDER: maybe explain here that subprocess-wait should be called
@; after all the I/O to ensure the process is in a position to terminate?

@history[#:changed "6.11.0.1" @elem{Added the @racket[group] argument.}
#:changed "7.4.0.5" @elem{Added waiting for a fifo without a reader
as @racket[stdout] and/or @racket[stderr].}
Expand Down Expand Up @@ -429,6 +432,8 @@ function:
(with-output-to-string (lambda () (system "date")))
]}

@; PLACEHOLDER: add something explaining why system* is recommended instead
@; (sorawee)

@defproc*[([(system* [command path-string?]
[arg (or/c path? string-no-nuls? bytes-no-nuls?)] ...
Expand Down
4 changes: 4 additions & 0 deletions pkgs/racket-doc/syntax/scribblings/parse/define.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ Defines a macro named @racket[macro-id]; equivalent to:
(syntax-parser parse-option ... clause ...))
]

This form does not explicitly mention the syntax object being parsed,
but as in the case of any use of @racket[syntax-parse], you can access
it via @racket[this-syntax].

@examples[#:eval the-eval
(define-syntax-parser fn3
[(fn3 x:id rhs:expr)
Expand Down
4 changes: 3 additions & 1 deletion pkgs/racket-doc/syntax/scribblings/parse/parsing.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,9 @@ Suppresses the ``colon notation'' for annotated pattern variables.
@defform[(syntax-parser parse-option ... clause ...+)]{

Like @racket[syntax-parse], but produces a matching procedure. The
procedure accepts a single argument, which should be a syntax object.
procedure accepts a single argument, which should be a syntax
object. The syntax object is accessible within the body of the form
via @racket[this-syntax].
}

@defform[(define/syntax-parse syntax-pattern pattern-directive ... stx-expr)
Expand Down