diff --git a/collects/scribblings/reference/code-inspectors.scrbl b/collects/scribblings/reference/code-inspectors.scrbl index f7a92d1c51..b9d053bd20 100644 --- a/collects/scribblings/reference/code-inspectors.scrbl +++ b/collects/scribblings/reference/code-inspectors.scrbl @@ -57,5 +57,5 @@ requires control over the old one). @defparam[current-code-inspector insp inspector?]{ -A parameter that determines an inspector to control access to module +A @tech{parameter} that determines an inspector to control access to module bindings and redefinitions.} diff --git a/collects/scribblings/reference/contracts.scrbl b/collects/scribblings/reference/contracts.scrbl index 687b308545..9592dd3a10 100644 --- a/collects/scribblings/reference/contracts.scrbl +++ b/collects/scribblings/reference/contracts.scrbl @@ -1750,7 +1750,7 @@ to the error message guidelines in @secref["err-msg-conventions"]. proc (-> blame? any/c string? string?)]{ -A parameter that is used when constructing a +A @tech{parameter} that is used when constructing a contract violation error. Its value is procedure that accepts three arguments: @itemize[ diff --git a/collects/scribblings/reference/custodians.scrbl b/collects/scribblings/reference/custodians.scrbl index d9fe1b495c..5b36b98642 100644 --- a/collects/scribblings/reference/custodians.scrbl +++ b/collects/scribblings/reference/custodians.scrbl @@ -42,7 +42,7 @@ thread.} @margin-note{In GRacket, custodians also manage @|eventspaces|.} -A parameter that determines a custodian that assumes responsibility +A @tech{parameter} that determines a custodian that assumes responsibility for newly created threads, @tech{file-stream ports}, TCP ports, @tech{TCP listeners}, @tech{UDP sockets}, and @tech{byte converters}.} diff --git a/collects/scribblings/reference/encodings.scrbl b/collects/scribblings/reference/encodings.scrbl index ccffbcfb8b..00be0d72c1 100644 --- a/collects/scribblings/reference/encodings.scrbl +++ b/collects/scribblings/reference/encodings.scrbl @@ -76,7 +76,7 @@ UTF-8 for encoding. @defparam[current-locale locale (or/c string? #f)]{ -A parameter that determines the current @tech{locale} for +A @tech{parameter} that determines the current @tech{locale} for procedures such as @racket[string-locale-ci=?]. When locale sensitivity is disabled by setting the parameter to diff --git a/collects/scribblings/reference/eval.scrbl b/collects/scribblings/reference/eval.scrbl index 0e81836334..d393d1abb2 100644 --- a/collects/scribblings/reference/eval.scrbl +++ b/collects/scribblings/reference/eval.scrbl @@ -5,7 +5,7 @@ @defparam[current-eval proc (any/c . -> . any)]{ -A parameter that determines the current @deftech{evaluation handler}. +A @tech{parameter} that determines the current @deftech{evaluation handler}. The evaluation handler is a procedure that takes a top-level form and evaluates it, returning the resulting values. The @tech{evaluation handler} is called by @racket[eval], @racket[eval-syntax], the default @@ -83,7 +83,7 @@ and its lexical context is not enriched before it is passed to the . -> . any)]{ -A parameter that determines the current @deftech{load handler} to load +A @tech{parameter} that determines the current @deftech{load handler} to load top-level forms from a file. The @tech{load handler} is called by @racket[load], @racket[load-relative], @racket[load/cd], and the default @tech{compiled-load handler}. @@ -204,7 +204,7 @@ handler}.} @defparam[current-load-extension proc (path? (or/c symbol? #f) . -> . any)]{ -A parameter that determines a @deftech{extension-load handler}, which is +A @tech{parameter} that determines a @deftech{extension-load handler}, which is called by @racket[load-extension] and the default @tech{compiled-load handler}. @@ -236,7 +236,7 @@ Like @racket[load-extension], but resolves @racket[file] using (non-empty-listof symbol?))) . -> . any)]{ -A parameter that determines the current @deftech{compiled-load +A @tech{parameter} that determines the current @deftech{compiled-load handler} to load from a file that may have a compiled form. The @tech{compiled-load handler} is called by @racket[load/use-compiled]. @@ -313,7 +313,7 @@ Calls the current @tech{compiled-load handler} in tail position.} @defparam[current-load-relative-directory path (or/c (and/c path-string? complete-path?) #f)]{ -A parameter that is set by @racket[load], @racket[load-relative], +A @tech{parameter} that is set by @racket[load], @racket[load-relative], @racket[load-extension], @racket[load-relative-extension], and the default @tech{compiled-load handler}, and used by @racket[load-relative], @racket[load-relative-extension], and the @@ -351,7 +351,7 @@ the @racket[current-prompt-read], @racket[current-eval], and @defparam[current-prompt-read proc (-> any)]{ -A parameter that determines a @deftech{prompt read handler}, which is +A @tech{parameter} that determines a @deftech{prompt read handler}, which is a procedure that takes no arguments, displays a prompt string, and returns a top-level form to evaluate. The prompt read handler is called by @racket[read-eval-print-loop], and after printing a prompt, @@ -378,7 +378,7 @@ before returning the read result.} @defparam[current-get-interaction-input-port proc (-> input-port?)]{ -A parameter that determines the @deftech{interaction port handler}, +A @tech{parameter} that determines the @deftech{interaction port handler}, which returns a port to use for @racket[read-eval-print-loop] inputs. The default interaction port handler returns the current input port. @@ -393,7 +393,7 @@ blocks.} @defparam[current-read-interaction proc (any/c input-port? -> any)]{ -A parameter that determines the current @deftech{read interaction +A @tech{parameter} that determines the current @deftech{read interaction handler}, which is procedure that takes an arbitrary value and an input port and returns an expression read from the input port. @@ -409,7 +409,7 @@ The default read interaction handler accepts @racket[_src] and @defparam[current-print proc (any/c -> any)]{ -A parameter that determines the @deftech{print handler} that is called +A @tech{parameter} that determines the @deftech{print handler} that is called by @racket[read-eval-print-loop] to print the result of an evaluation (and the result is ignored). @@ -421,7 +421,7 @@ The default @tech{print handler} @racket[print]s the value to the @defparam[current-compile proc (any/c boolean? . -> . compiled-expression?)]{ -A parameter that determines the current @deftech{compilation handler}. +A @tech{parameter} that determines the current @deftech{compilation handler}. The @tech{compilation handler} is a procedure that takes a top-level form and returns a compiled form; see @secref["compilation-model"] for more information on compilation. @@ -465,7 +465,7 @@ otherwise.} @defboolparam[compile-enforce-module-constants on?]{ -A parameter that determines how a module declaration is compiled. +A @tech{parameter} that determines how a module declaration is compiled. When constants are enforced, and when the macro-expanded body of a module contains no @racket[set!] assignment to a particular variable @@ -481,7 +481,7 @@ generate code that skips certain run-time checks.} @defboolparam[compile-allow-set!-undefined allow?]{ -A parameter that determines how a @racket[set!] expression is compiled +A @tech{parameter} that determines how a @racket[set!] expression is compiled when it mutates a global variable. If the value of this parameter is a true value, @racket[set!] expressions for global variables are compiled so that the global variable is set even if it was not @@ -494,7 +494,7 @@ when it is @italic{evaluated}.} @defboolparam[compile-context-preservation-enabled on?]{ -A parameter that determines whether compilation should avoid +A @tech{parameter} that determines whether compilation should avoid function-call inlining and other optimizations that may cause information to be lost from stack traces (as reported by @racket[continuation-mark-set->context]). The default is @racket[#f], @@ -504,7 +504,7 @@ which allows such optimizations.} @guidealso["JIT"] -A parameter that determines whether the native-code just-in-time +A @tech{parameter} that determines whether the native-code just-in-time compiler (@deftech{JIT}) is enabled for code (compiled or not) that is passed to the default evaluation handler. A true parameter value is effective only on platforms for which the JIT is supported. @@ -518,7 +518,7 @@ value).} @defboolparam[load-on-demand-enabled on?]{ -A parameter that determines whether the default @tech{load handler} +A @tech{parameter} that determines whether the default @tech{load handler} sets @racket[read-on-demand-source]. See @racket[current-load] for more information. The default is @racket[#t], unless it is disabled through the @Flag{d}/@DFlag{no-delay} command-line flag.} diff --git a/collects/scribblings/reference/evts.scrbl b/collects/scribblings/reference/evts.scrbl index 7bfd3365a6..62a38aacdb 100644 --- a/collects/scribblings/reference/evts.scrbl +++ b/collects/scribblings/reference/evts.scrbl @@ -406,5 +406,5 @@ and the @racket[prop:input-port] property takes precedence over @defparam[current-evt-pseudo-random-generator generator pseudo-random-generator?]{ -A parameter that determines the pseudo-random number generator used by +A @tech{parameter} that determines the pseudo-random number generator used by @racket[sync] for events created by @racket[choice-evt].} diff --git a/collects/scribblings/reference/exit.scrbl b/collects/scribblings/reference/exit.scrbl index 16023025bc..d7b64b0e13 100644 --- a/collects/scribblings/reference/exit.scrbl +++ b/collects/scribblings/reference/exit.scrbl @@ -12,7 +12,7 @@ returned.} @defparam[exit-handler proc (any/c . -> . any)]{ -A parameter that determines the current @deftech{exit handler}. The +A @tech{parameter} that determines the current @deftech{exit handler}. The @tech{exit handler} is called by @racket[exit]. The default @tech{exit handler} in the Racket executable @@ -25,7 +25,7 @@ means ``success'').} @defparam[executable-yield-handler proc (byte? . -> . any)]{ -A parameter that determines a procedure to be called as the Racket +A @tech{parameter} that determines a procedure to be called as the Racket process is about to exit normally. The procedure associated with this parameter is not called when @racket[exit] (or, more precisely, the default @tech{exit handler}) is used to exit early. The argument to diff --git a/collects/scribblings/reference/exns.scrbl b/collects/scribblings/reference/exns.scrbl index 010804337c..d418c8204c 100644 --- a/collects/scribblings/reference/exns.scrbl +++ b/collects/scribblings/reference/exns.scrbl @@ -534,7 +534,7 @@ after the first @racket[cnt] lines. A @racket[0] value for . -> . string?)]{ -A parameter that determines the @deftech{error value conversion +A @tech{parameter} that determines the @deftech{error value conversion handler}, which is used to print a Racket value that is embedded in a primitive error message. @@ -559,7 +559,7 @@ enable printing of unreadable values (see @racket[print-unreadable]).} @defboolparam[error-print-source-location include?]{ -A parameter that controls whether read and syntax error messages +A @tech{parameter} that controls whether read and syntax error messages include source information, such as the source line and column or the expression. This parameter also controls the error message when a module-defined variable is accessed before its definition is executed; diff --git a/collects/scribblings/reference/filesystem.scrbl b/collects/scribblings/reference/filesystem.scrbl index adcfd15123..b40ce3dbf9 100644 --- a/collects/scribblings/reference/filesystem.scrbl +++ b/collects/scribblings/reference/filesystem.scrbl @@ -394,7 +394,7 @@ See also: @racket[rename-file-or-directory], @defparam[current-directory path path-string?]{ -A parameter that determines the current directory for resolving +A @tech{parameter} that determines the current directory for resolving relative paths. When the parameter procedure is called to set the current directory, diff --git a/collects/scribblings/reference/match.scrbl b/collects/scribblings/reference/match.scrbl index bc1a743c8f..23ba9a1e5a 100644 --- a/collects/scribblings/reference/match.scrbl +++ b/collects/scribblings/reference/match.scrbl @@ -557,7 +557,7 @@ Like @racket[prop:match-expander], but for the legacy match syntax. @defparam[match-equality-test comp-proc (any/c any/c . -> . any)]{ -A parameter that determines the comparison procedure used to check +A @tech{parameter} that determines the comparison procedure used to check whether multiple uses of an identifier match the ``same'' value. The default is @racket[equal?].} diff --git a/collects/scribblings/reference/module-reflect.scrbl b/collects/scribblings/reference/module-reflect.scrbl index d878946dd8..f9c4b21c47 100644 --- a/collects/scribblings/reference/module-reflect.scrbl +++ b/collects/scribblings/reference/module-reflect.scrbl @@ -71,7 +71,7 @@ the grammar for @racket[_module-path] for @racket[require], . -> . resolved-module-path?))]{ -A parameter that determines the current @deftech{module name +A @tech{parameter} that determines the current @deftech{module name resolver}, which manages the conversion from other kinds of module references to a @tech{resolved module path}. For example, when the expander encounters @racket[(require _module-path)] where @@ -150,7 +150,7 @@ should not necessarily be loaded in the current namespace.} @defparam[current-module-declare-name name (or/c resolved-module-path? #f)]{ -A parameter that determines a module name that is used when evaluating +A @tech{parameter} that determines a module name that is used when evaluating a @racket[module] declaration (when the parameter value is not @racket[#f]). In that case, the @racket[_id] from the @racket[module] declaration is ignored, and the parameter's value is used as the name @@ -163,7 +163,7 @@ submodule path relative to the root module is unaffected.} @defparam[current-module-declare-source src (or/c symbol? (and/c path? complete-path?) #f)]{ -A parameter that determines source information to be associated with a +A @tech{parameter} that determines source information to be associated with a module when evaluating a @racket[module] declaration. Source information is used in error messages and reflected by @racket[variable-reference->module-source]. When the parameter value diff --git a/collects/scribblings/reference/namespaces.scrbl b/collects/scribblings/reference/namespaces.scrbl index 3bd573d30a..eff8c265bb 100644 --- a/collects/scribblings/reference/namespaces.scrbl +++ b/collects/scribblings/reference/namespaces.scrbl @@ -89,7 +89,7 @@ anchor definition was evaluated.} @defparam[current-namespace n namespace?]{ -A parameter that determines the @techlink{current namespace}.} +A @tech{parameter} that determines the @techlink{current namespace}.} @defproc[(namespace-symbol->identifier [sym symbol?]) identifier?]{ diff --git a/collects/scribblings/reference/numbers.scrbl b/collects/scribblings/reference/numbers.scrbl index b3c3e40695..455610319f 100644 --- a/collects/scribblings/reference/numbers.scrbl +++ b/collects/scribblings/reference/numbers.scrbl @@ -883,7 +883,7 @@ Returns @racket[#t] if @racket[v] is a pseudo-random number generator, @defparam[current-pseudo-random-generator generator pseudo-random-generator?]{ -A parameter that determines the pseudo-random number generator +A @tech{parameter} that determines the pseudo-random number generator used by @racket[random].} diff --git a/collects/scribblings/reference/port-line-counting.scrbl b/collects/scribblings/reference/port-line-counting.scrbl index 22cfd1d327..e34a2cc0fb 100644 --- a/collects/scribblings/reference/port-line-counting.scrbl +++ b/collects/scribblings/reference/port-line-counting.scrbl @@ -100,6 +100,6 @@ a @tech{custom port} that defines its own counting function, then @defboolparam[port-count-lines-enabled on?]{ -A parameter that determines whether line counting is enabled +A @tech{parameter} that determines whether line counting is enabled automatically for newly created ports. The default value is @racket[#f].} diff --git a/collects/scribblings/reference/port-procs.scrbl b/collects/scribblings/reference/port-procs.scrbl index cce7e0dc8c..31ac977d02 100644 --- a/collects/scribblings/reference/port-procs.scrbl +++ b/collects/scribblings/reference/port-procs.scrbl @@ -33,15 +33,15 @@ closed, @racket[#f] otherwise.} Return a @tech{synchronizable event} that becomes ready when @racket[port] is closed.} -@defparam[current-input-port in input-port?]{A parameter that +@defparam[current-input-port in input-port?]{A @tech{parameter} that determines a default input port for many operations, such as @racket[read].} -@defparam[current-output-port out output-port?]{A parameter that +@defparam[current-output-port out output-port?]{A @tech{parameter} that determines a default output port for many operations, such as @racket[write].} -@defparam[current-error-port out output-port?]{A parameter that +@defparam[current-error-port out output-port?]{A @tech{parameter} that determines an output port that is typically used for errors and logging. For example, the default error display handler writes to this port.} diff --git a/collects/scribblings/reference/pretty-print.scrbl b/collects/scribblings/reference/pretty-print.scrbl index 28f736364b..1a7aa3fec8 100644 --- a/collects/scribblings/reference/pretty-print.scrbl +++ b/collects/scribblings/reference/pretty-print.scrbl @@ -78,7 +78,7 @@ by @racket[read-eval-print-loop].} @defparam[pretty-print-columns width (or/c exact-positive-integer? 'infinity)]{ -A parameter that determines the default width for pretty printing. +A @tech{parameter} that determines the default width for pretty printing. If the display width is @racket['infinity], then pretty-printed output is never broken into lines, and a newline is not added to the end of @@ -97,14 +97,14 @@ depths.} @defboolparam[pretty-print-exact-as-decimal as-decimal?]{ -A parameter that determines how exact non-integers are printed. If +A @tech{parameter} that determines how exact non-integers are printed. If the parameter's value is @racket[#t], then an exact non-integer with a decimal representation is printed as a decimal number instead of a fraction. The initial value is @racket[#f].} @defboolparam[pretty-print-.-symbol-without-bars on?]{ -A parameter that controls the printing of the symbol whose print name +A @tech{parameter} that controls the printing of the symbol whose print name is just a period. If set to a true value, then such a symbol is printed as only the period. If set to a false value, it is printed as a period with vertical bars surrounding it.} @@ -112,7 +112,7 @@ a period with vertical bars surrounding it.} @defboolparam[pretty-print-show-inexactness show?]{ -A parameter that determines how inexact numbers are printed. If the +A @tech{parameter} that determines how inexact numbers are printed. If the parameter's value is @racket[#t], then inexact numbers are always printed with a leading @litchar{#i}. The initial value is @racket[#f].} @@ -123,7 +123,7 @@ printed with a leading @litchar{#i}. The initial value is @racket[#f].} @defboolparam[pretty-print-abbreviate-read-macros abbrev?]{ -A parameter that controls whether or not @racketidfont{quote}, +A @tech{parameter} that controls whether or not @racketidfont{quote}, @racketidfont{unquote}, @racketidfont{unquote-splicing}, @|etc|, are abbreviated with @litchar{'}, @litchar{,}, @litchar[",@"], etc. By default, the abbreviations are enabled. @@ -140,7 +140,7 @@ Returns @racket[#t] if @racket[v] is a style table for use with @defparam[pretty-print-current-style-table style-table pretty-print-style-table?]{ -A parameter that holds a table of style mappings. See +A @tech{parameter} that holds a table of style mappings. See @racket[pretty-print-extend-style-table].} @@ -191,7 +191,7 @@ so that the output follows popular code-formatting rules: proc (any/c . -> . (or/c symbol? #f))]{ -A parameter that controls remapping for styles and for the determination of +A @tech{parameter} that controls remapping for styles and for the determination of the reader shorthands. This procedure is @@ -227,7 +227,7 @@ target column width, typically obtained from . -> . exact-nonnegative-integer?)]{ -A parameter that determines a procedure for printing the newline +A @tech{parameter} that determines a procedure for printing the newline separator between lines of a pretty-printed value. The procedure is called with four arguments: a new line number, an output port, the old line's length, and the number of destination columns. The return value @@ -270,7 +270,7 @@ redirected to the port supplied to @racket[pretty-print] or . -> . (or/c #f exact-nonnegative-integer?))]{ -A parameter that determines a sizing hook for pretty-printing. +A @tech{parameter} that determines a sizing hook for pretty-printing. The sizing hook is applied to each value to be printed. If the hook returns @racket[#f], then printing is handled internally by the @@ -292,7 +292,7 @@ pretty-printing.} @defparam[pretty-print-print-hook proc (any/c boolean? output-port? . -> . void?)]{ -A parameter that determines a print hook for pretty-printing. The +A @tech{parameter} that determines a print hook for pretty-printing. The print-hook procedure is applied to a value for printing when the sizing hook (see @racket[pretty-print-size-hook]) returns an integer size for the value. @@ -310,7 +310,7 @@ this port is ultimately redirected to the port supplied to @defparam[pretty-print-pre-print-hook proc (any/c output-port? . -> . void)]{ -A parameter that determines a hook procedure to be called just before +A @tech{parameter} that determines a hook procedure to be called just before an object is printed. The hook receives two arguments: the object and the output port. The port is the one supplied to @racket[pretty-print] or @racket[pretty-display] (or the current output port).} @@ -319,7 +319,7 @@ or @racket[pretty-display] (or the current output port).} @defparam[pretty-print-post-print-hook proc (any/c output-port? . -> . void)]{ -A parameter that determines a hook procedure to be called just after +A @tech{parameter} that determines a hook procedure to be called just after an object is printed. The hook receives two arguments: the object and the output port. The port is the one supplied to @racket[pretty-print] or @racket[pretty-display] (or the current output port).} @@ -330,7 +330,7 @@ or @racket[pretty-display] (or the current output port).} @defboolparam[pretty-printing on?]{ -A parameter that is set to @racket[#t] when the pretty printer calls a +A @tech{parameter} that is set to @racket[#t] when the pretty printer calls a custom-write procedure (see @racket[prop:custom-write]) for output in a mode that supports line breaks. When pretty printer calls a custom-write procedure merely to detect cycles or to try to print on a diff --git a/collects/scribblings/reference/read.scrbl b/collects/scribblings/reference/read.scrbl index 817b7a1c71..d1fdfb2c9d 100644 --- a/collects/scribblings/reference/read.scrbl +++ b/collects/scribblings/reference/read.scrbl @@ -176,7 +176,7 @@ called. The default @racket[fail-thunk] raises @defboolparam[read-case-sensitive on?]{ -A parameter that controls parsing and printing of symbols. When this +A @tech{parameter} that controls parsing and printing of symbols. When this parameter's value is @racket[#f], the reader case-folds symbols (e.g., producing @racket['hi] when the input is any one of @litchar{hi}, @litchar{Hi}, @litchar{HI}, or @litchar{hI}). The parameter also @@ -192,30 +192,30 @@ loaded, the parameter is set to @racket[#t] (see @defboolparam[read-square-bracket-as-paren on?]{ -A parameter that controls whether @litchar{[} and @litchar{]} +A @tech{parameter} that controls whether @litchar{[} and @litchar{]} are treated as parentheses. See @secref["parse-pair"] for more information.} @defboolparam[read-curly-brace-as-paren on?]{ -A parameter that controls whether @litchar["{"] and @litchar["}"] +A @tech{parameter} that controls whether @litchar["{"] and @litchar["}"] are treated as parentheses. See @secref["parse-pair"] for more information.} @defboolparam[read-accept-box on?]{ -A parameter that controls parsing @litchar{#&} input. See +A @tech{parameter} that controls parsing @litchar{#&} input. See @secref["parse-box"] for more information.} @defboolparam[read-accept-compiled on?]{ -A parameter that controls parsing @litchar{#~} compiled input. See +A @tech{parameter} that controls parsing @litchar{#~} compiled input. See @secref["reader"] and @racket[current-compile] for more information.} @defboolparam[read-accept-bar-quote on?]{ -A parameter that controls parsing and printing of @litchar{|} in +A @tech{parameter} that controls parsing and printing of @litchar{|} in symbols. See @secref["parse-symbol"] and @secref["printing"] for more information.} @@ -226,37 +226,37 @@ A parameter value that controls parsing input with sharing. See @defboolparam[read-decimal-as-inexact on?]{ -A parameter that controls parsing input numbers with a decimal point +A @tech{parameter} that controls parsing input numbers with a decimal point or exponent (but no explicit exactness tag). See @secref["parse-number"] for more information.} @defboolparam[read-accept-dot on?]{ -A parameter that controls parsing input with a dot, which is normally +A @tech{parameter} that controls parsing input with a dot, which is normally used for literal cons cells. See @secref["parse-pair"] for more information.} @defboolparam[read-accept-infix-dot on?]{ -A parameter that controls parsing input with two dots to trigger infix +A @tech{parameter} that controls parsing input with two dots to trigger infix conversion. See @secref["parse-pair"] for more information.} @defboolparam[read-accept-quasiquote on?]{ -A parameter that controls parsing input with @litchar{`} or +A @tech{parameter} that controls parsing input with @litchar{`} or @litchar{,} which is normally used for @racket[quasiquote], @racket[unquote], and @racket[unquote-splicing] abbreviations. See @secref["parse-quote"] for more information.} @defboolparam[read-accept-reader on?]{ -A parameter that controls whether @litchar{#reader}, @litchar{#lang}, +A @tech{parameter} that controls whether @litchar{#reader}, @litchar{#lang}, or @litchar{#!} are allowed for selecting a parser. See @secref["parse-reader"] for more information.} @defboolparam[read-accept-lang on?]{ -A parameter that (along with @racket[read-accept-reader] controls +A @tech{parameter} that (along with @racket[read-accept-reader] controls whether @litchar{#lang} and @litchar{#!} are allowed for selecting a parser. See @secref["parse-reader"] for more information.} @@ -276,7 +276,7 @@ default behavior. See @secref["readtables"] for more information.} @defparam[read-on-demand-source path (and/c path? complete-path?)]{ -A parameter that enables lazy parsing of compiled code, so that +A @tech{parameter} that enables lazy parsing of compiled code, so that closure bodies and syntax objects are extracted (and validated) from marshaled compiled code on demand. Normally, this parameter is set by the default @tech{load handler} when @racket[load-on-demand-enabled] diff --git a/collects/scribblings/reference/runtime.scrbl b/collects/scribblings/reference/runtime.scrbl index 4e65b7daf6..84417a4894 100644 --- a/collects/scribblings/reference/runtime.scrbl +++ b/collects/scribblings/reference/runtime.scrbl @@ -116,14 +116,14 @@ ends with a newline.} @defparam[current-command-line-arguments argv (vectorof (and/c string? immutable?))]{ -A parameter that is initialized with command-line arguments when +A @tech{parameter} that is initialized with command-line arguments when Racket starts (not including any command-line arguments that were treated as flags for the system).} @defparam[current-thread-initial-stack-size size exact-positive-integer?]{ -A parameter that provides a hint about how much space to reserve for a +A @tech{parameter} that provides a hint about how much space to reserve for a newly created thread's local variables. The actual space used by a computation is affected by @tech{JIT} compilation, but it is otherwise platform-independent.} diff --git a/collects/scribblings/reference/sandbox.scrbl b/collects/scribblings/reference/sandbox.scrbl index d045c693be..79006e7555 100644 --- a/collects/scribblings/reference/sandbox.scrbl +++ b/collects/scribblings/reference/sandbox.scrbl @@ -328,7 +328,7 @@ ports settings are not included.)} @defparam[sandbox-init-hook thunk (-> any)]{ -A parameter that determines a thunk to be called for initializing a +A @tech{parameter} that determines a thunk to be called for initializing a new evaluator. The hook is called just before the program is evaluated in a newly-created evaluator context. It can be used to setup environment parameters related to reading, writing, evaluation, @@ -339,7 +339,7 @@ hook is used after that initialization, so it can override settings.} @defparam[sandbox-reader proc (any/c . -> . any)]{ -A parameter that specifies a function that reads all expressions from +A @tech{parameter} that specifies a function that reads all expressions from @racket[(current-input-port)]. The function is used to read program source for an evaluator when a string, byte string, or port is supplied. The reader function receives a value to be used as input @@ -360,7 +360,7 @@ used to read the program input for @racket[make-module-evaluator], 'pipe (-> input-port?))]{ -A parameter that determines the initial @racket[current-input-port] +A @tech{parameter} that determines the initial @racket[current-input-port] setting for a newly created evaluator. It defaults to @racket[#f], which creates an empty port. The following other values are allowed: @@ -389,7 +389,7 @@ which creates an empty port. The following other values are allowed: 'string (-> output-port?))]{ -A parameter that determines the initial @racket[current-output-port] +A @tech{parameter} that determines the initial @racket[current-output-port] setting for a newly created evaluator. It defaults to @racket[#f], which creates a port that discards all data. The following other values are allowed: @@ -436,7 +436,7 @@ generated evaluator goes to the calling context's error port.} @defboolparam[sandbox-coverage-enabled enabled?]{ -A parameter that controls whether syntactic coverage information is +A @tech{parameter} that controls whether syntactic coverage information is collected by sandbox evaluators. Use @racket[get-uncovered-expressions] to retrieve coverage information.} @@ -459,7 +459,7 @@ further). The default is @racket[#t].} @defboolparam[sandbox-propagate-exceptions propagate?]{ -A parameter that controls how uncaught exceptions during a sandbox +A @tech{parameter} that controls how uncaught exceptions during a sandbox evaluation are treated. When the parameter value is @racket[#t], then the exception is propagated to the caller of sandbox. When the parameter value is @racket[#f], the exception message @@ -471,7 +471,7 @@ is @racket[#t].} @defparam[sandbox-namespace-specs spec (cons/c (-> namespace?) (listof module-path?))]{ -A parameter that holds a list of values that specify how to create a +A @tech{parameter} that holds a list of values that specify how to create a namespace for evaluation in @racket[make-evaluator] or @racket[make-module-evaluator]. The first item in the list is a thunk that creates the namespace, and the rest are module paths for modules @@ -521,7 +521,7 @@ available, such as using a new eventspace for each evaluator.} @defparam[sandbox-override-collection-paths paths (listof path-string?)]{ -A parameter that determines a list of collection directories to prefix +A @tech{parameter} that determines a list of collection directories to prefix @racket[current-library-collection-paths] in an evaluator. This parameter is useful for cases when you want to test code using an alternate, test-friendly version of a collection, for example, testing @@ -533,7 +533,7 @@ actual interaction. The default is @racket[null].} @defparam[sandbox-security-guard guard (or/c security-guard? (-> security-guard?))]{ -A parameter that determines the initial +A @tech{parameter} that determines the initial @racket[(current-security-guard)] for sandboxed evaluations. It can be either a security guard, or a function to construct one. The default is a function that restricts the access of the current @@ -547,7 +547,7 @@ specifications in @racket[sandbox-path-permissions], and it uses 'read-bytecode 'read 'exists) (or/c byte-regexp? bytes? string? path?)))]{ -A parameter that configures the behavior of the default sandbox +A @tech{parameter} that configures the behavior of the default sandbox security guard by listing paths and access modes that are allowed for them. The contents of this parameter is a list of specifications, each is an access mode and a byte-regexp for paths that are granted this @@ -594,14 +594,14 @@ to use collection libraries (including (or/c 'server 'client) . -> . any)]{ -A parameter that specifies a procedure to be used (as is) by the +A @tech{parameter} that specifies a procedure to be used (as is) by the default @racket[sandbox-security-guard]. The default forbids all network connection.} @defparam[sandbox-exit-handler handler (any/c . -> . any)]{ -A parameter that determines the initial @racket[(exit-handler)] for +A @tech{parameter} that determines the initial @racket[(exit-handler)] for sandboxed evaluations. The default kills the evaluator with an appropriate error message (see @racket[exn:fail:sandbox-terminated-reason]).} @@ -609,7 +609,7 @@ appropriate error message (see @defparam[sandbox-memory-limit limit (or/c nonnegative-number? #f)]{ -A parameter that determines the total memory limit on the sandbox in +A @tech{parameter} that determines the total memory limit on the sandbox in megabytes (it can hold a rational or a floating point number). When this limit is exceeded, the sandbox is terminated. This value is used when the sandbox is created and the limit cannot be changed @@ -646,7 +646,7 @@ than one block counts against the interaction limit).} (or/c nonnegative-number? #f)) #f)]{ -A parameter that determines the default limits on @italic{each} use of +A @tech{parameter} that determines the default limits on @italic{each} use of a @racket[make-evaluator] function, including the initial evaluation of the input program. Its value should be a list of two numbers; where the first is a timeout value in seconds, and the second is a @@ -715,7 +715,7 @@ then, assuming sufficiently small limits, (list/c (or/c #f ((-> any) . -> . any)) (or/c #f ((-> any) . -> . any)))]{ -A parameter that determines two (optional) handlers that wrap +A @tech{parameter} that determines two (optional) handlers that wrap sandboxed evaluations. The first one is used when evaluating the initial program when the sandbox is being set-up, and the second is used for each interaction. Each of these handlers should expect a @@ -731,7 +731,7 @@ other resources intact.} @defparam[sandbox-make-inspector make (-> inspector?)]{ -A parameter that determines the (nullary) procedure that is used to +A @tech{parameter} that determines the (nullary) procedure that is used to create the inspector for sandboxed evaluation. The procedure is called when initializing an evaluator. The default parameter value is @racket[(lambda () (make-inspector (current-inspector)))].} @@ -739,7 +739,7 @@ when initializing an evaluator. The default parameter value is @defparam[sandbox-make-code-inspector make (-> inspector?)]{ -A parameter that determines the (nullary) procedure that is used to +A @tech{parameter} that determines the (nullary) procedure that is used to create the code inspector for sandboxed evaluation. The procedure is called when initializing an evaluator. The default parameter value is @racket[(lambda () (make-inspector (current-code-inspector)))]. @@ -753,7 +753,7 @@ possible.} @defparam[sandbox-make-logger make (-> logger?)]{ -A parameter that determines the procedure used to create the logger +A @tech{parameter} that determines the procedure used to create the logger for sandboxed evaluation. The procedure is called when initializing an evaluator, and the default parameter value is @racket[current-logger]. This means that it is not creating a new diff --git a/collects/scribblings/reference/security-guards.scrbl b/collects/scribblings/reference/security-guards.scrbl index 9706765a2b..a2d34ff17b 100644 --- a/collects/scribblings/reference/security-guards.scrbl +++ b/collects/scribblings/reference/security-guards.scrbl @@ -148,7 +148,7 @@ into or out of the @racket[file-guard] or @racket[network-guard] call @defparam[current-security-guard guard security-guard?]{ -A parameter that determines the current security guard that controls +A @tech{parameter} that determines the current security guard that controls access to the filesystem and network.} diff --git a/collects/scribblings/reference/struct-inspectors.scrbl b/collects/scribblings/reference/struct-inspectors.scrbl index f3b43fe58e..47e2339657 100644 --- a/collects/scribblings/reference/struct-inspectors.scrbl +++ b/collects/scribblings/reference/struct-inspectors.scrbl @@ -46,7 +46,7 @@ inspector control mutually disjoint sets of structure types.} @defparam[current-inspector insp inspector?]{ -A parameter that determines the default inspector for newly created +A @tech{parameter} that determines the default inspector for newly created structure types.} diff --git a/collects/scribblings/reference/stx-trans.scrbl b/collects/scribblings/reference/stx-trans.scrbl index 0fe136aff1..bef3462726 100644 --- a/collects/scribblings/reference/stx-trans.scrbl +++ b/collects/scribblings/reference/stx-trans.scrbl @@ -948,7 +948,7 @@ into a module. @defparam[current-require-module-path module-path (or/c #f module-path-index?)]{ -A parameter that determines how relative @racket[require]-level module +A @tech{parameter} that determines how relative @racket[require]-level module paths are expanded to @racket[#%require]-level module paths by @racket[convert-relative-module-path] (which is used implicitly by all built-in @racket[require] sub-forms). diff --git a/collects/scribblings/reference/thread-groups.scrbl b/collects/scribblings/reference/thread-groups.scrbl index 422cd8cc2c..cb46836ed1 100644 --- a/collects/scribblings/reference/thread-groups.scrbl +++ b/collects/scribblings/reference/thread-groups.scrbl @@ -32,5 +32,5 @@ otherwise.} @defparam[current-thread-group group thread-group?]{ -A parameter that determines the thread group for newly created +A @tech{parameter} that determines the thread group for newly created threads.} diff --git a/collects/scribblings/reference/trace.scrbl b/collects/scribblings/reference/trace.scrbl index ac33ec9693..2394295c72 100644 --- a/collects/scribblings/reference/trace.scrbl +++ b/collects/scribblings/reference/trace.scrbl @@ -62,7 +62,7 @@ The result of an @racket[untrace] expression is @|void-const|.} @defparam[current-trace-notify proc (string? . -> . any)]{ -A parameter that determines the way that trace output is +A @tech{parameter} that determines the way that trace output is displayed. The string given to @racket[proc] is a trace; it does not end with a newline, but it may contain internal newlines. Each call or result is converted into a string using @racket[pretty-print]. The diff --git a/collects/scribblings/reference/write.scrbl b/collects/scribblings/reference/write.scrbl index 1c72aaa97c..274691b3f8 100644 --- a/collects/scribblings/reference/write.scrbl +++ b/collects/scribblings/reference/write.scrbl @@ -167,20 +167,20 @@ Formats to a string. The result is the same as @defboolparam[print-pair-curly-braces on?]{ -A parameter that controls pair printing. If the value is true, then +A @tech{parameter} that controls pair printing. If the value is true, then pairs print using @litchar["{"] and @litchar["}"] instead of @litchar{(} and @litchar{)}. The default is @racket[#f].} @defboolparam[print-mpair-curly-braces on?]{ -A parameter that controls pair printing. If the value is true, then +A @tech{parameter} that controls pair printing. If the value is true, then mutable pairs print using @litchar["{"] and @litchar["}"] instead of @litchar{(} and @litchar{)}. The default is @racket[#t].} @defboolparam[print-unreadable on?]{ -A parameter that enables or disables printing of values that have no +A @tech{parameter} that enables or disables printing of values that have no @racket[read]able form (using the default reader), including structures that have a custom-write procedure (see @racket[prop:custom-write]), but not including @tech{uninterned} @@ -192,12 +192,12 @@ more information.} @defboolparam[print-graph on?]{ -A parameter that controls printing data with sharing; defaults to +A @tech{parameter} that controls printing data with sharing; defaults to @racket[#f]. See @secref["printing"] for more information.} @defboolparam[print-struct on?]{ -A parameter that controls printing structure values in vector or +A @tech{parameter} that controls printing structure values in vector or @tech{prefab} form; defaults to @racket[#t]. See @secref["printing"] for more information. This parameter has no effect on the printing of structures that have a custom-write procedure (see @@ -205,23 +205,23 @@ structures that have a custom-write procedure (see @defboolparam[print-box on?]{ -A parameter that controls printing box values; defaults to +A @tech{parameter} that controls printing box values; defaults to @racket[#t]. See @secref["print-box"] for more information.} @defboolparam[print-vector-length on?]{ -A parameter that controls printing vectors; defaults to +A @tech{parameter} that controls printing vectors; defaults to @racket[#f]. See @secref["print-vectors"] for more information.} @defboolparam[print-hash-table on?]{ -A parameter that controls printing hash tables; defaults to +A @tech{parameter} that controls printing hash tables; defaults to @racket[#f]. See @secref["print-hashtable"] for more information.} @defboolparam[print-boolean-long-form on?]{ -A parameter that controls printing of booleans. When the parameter's +A @tech{parameter} that controls printing of booleans. When the parameter's value is true, @racket[#t] and @racket[#f] print as @litchar{#true} and @litchar{#false}, otherwise they print as @litchar{#t} and @litchar{#f}. The default is @racket[#f].} @@ -229,7 +229,7 @@ and @litchar{#f}. The default is @racket[#f].} @defboolparam[print-reader-abbreviations on?]{ -A parameter that controls printing of two-element lists that start +A @tech{parameter} that controls printing of two-element lists that start with @racket[quote], @racket['quasiquote], @racket['unquote], @racket['unquote-splicing], @racket['syntax], @racket['quasisyntax], @racket['unsyntax], or @racket['unsyntax-splicing]; defaults to @@ -237,14 +237,14 @@ with @racket[quote], @racket['quasiquote], @racket['unquote], @defboolparam[print-as-expression on?]{ -A parameter that controls printing in @racket[print] mode (as opposed +A @tech{parameter} that controls printing in @racket[print] mode (as opposed to @racket[write] or @racket[display]); defaults to @racket[#t]. See @secref["printing"] for more information.} @defparam[print-syntax-width width (or/c +inf.0 0 (and/c exact-integer? (>/c 3)))]{ -A parameter that controls printing of @tech{syntax objects}. Up to +A @tech{parameter} that controls printing of @tech{syntax objects}. Up to @racket[width] characters are used to show the datum form of a syntax object within @litchar{#} (after the @tech{syntax object}'s source location, if any).} @@ -260,7 +260,7 @@ object within @litchar{#} (after the (and/c path? complete-path?)) #f)]{ -A parameter that is used when writing compiled code (see @secref["print-compiled"]) that contains +A @tech{parameter} that is used when writing compiled code (see @secref["print-compiled"]) that contains pathname literals, including source-location pathnames for procedure names. When the parameter's value is a @racket[_path], paths that syntactically extend @racket[_path] are converted to relative paths; when the resulting @@ -314,7 +314,7 @@ global port print handler is the same as the default write handler.} (any/c output-port? . -> . any))]) void?])]{ -A parameter that determines @deftech{global port print handler}, +A @tech{parameter} that determines @deftech{global port print handler}, which is called by the default port print handler (see @racket[port-print-handler]) to @racket[print] values into a port. The default value uses the built-in printer (see