Skip to content

Commit 378c404

Browse files
author
maechler
committed
{quiet}: alphabetically order options
git-svn-id: https://svn.r-project.org/R/trunk@88403 00db46b3-68df-0310-9c12-caf00c1e9a41
1 parent 5d2677e commit 378c404

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

src/library/base/man/options.Rd

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ getOption(x, default = NULL)
7070
a list with the previous values of the options changed (returned
7171
invisibly).
7272
}
73-
\section{Options used in base \R}{
73+
\section{Options used in base \R}{% --- sorted *alphabetically* --
7474
\describe{
7575
\item{\code{add.smooth}:}{typically logical, defaulting to
7676
\code{TRUE}. Could also be set to an integer for specifying how
@@ -355,6 +355,11 @@ getOption(x, default = NULL)
355355
\item{\code{prompt}:}{a non-empty string to be used for \R's prompt;
356356
should usually end in a blank (\code{" "}).}
357357

358+
\item{\code{quiet}:}{logical. Should \R be (more) \dQuote{quiet},
359+
notably on startup report? Set to \code{TRUE} by the command-line
360+
option \option{--quiet}. Note that \code{quiet} and \code{verbose}
361+
\emph{can} both be true.}
362+
358363
% verbatim, for checking " \t\n\"\\'`><=%;,|&{()}"
359364
\item{\code{rl_word_breaks}:}{(Unix only:) Used for the \I{readline}-based terminal
360365
interface. Default value \code{" \\t\\n\\"\\\\'`><=\%;,|&{()}"}.%"
@@ -450,10 +455,6 @@ getOption(x, default = NULL)
450455
on progress? Set to \code{TRUE} by the command-line option
451456
\option{--verbose}.}
452457

453-
\item{\code{quiet}:}{logical. Should \R be (more) \dQuote{quiet},
454-
notably on startup report? Set to \code{TRUE} by the command-line
455-
option \option{--quiet}.% \code{quiet} and \code{verbose} cannot both be true.
456-
}
457458
\item{\code{warn}:}{integer value to set the handling of warning
458459
messages by the default warning handler. If
459460
\code{warn} is negative all warnings are ignored. If \code{warn}
@@ -512,7 +513,7 @@ getOption(x, default = NULL)
512513
}
513514
}
514515

515-
The \sQuote{factory-fresh} default settings of some of these options are
516+
The \sQuote{factory-fresh} default settings of some of these options are (alphabetically)
516517
\tabular{ll}{
517518
\code{add.smooth} \tab \code{TRUE}\cr
518519
\code{check.bounds} \tab \code{FALSE}\cr
@@ -527,17 +528,18 @@ getOption(x, default = NULL)
527528
\code{max.print} \tab \code{99999}\cr
528529
\code{OutDec} \tab \code{"."}\cr
529530
\code{prompt} \tab \code{"> "}\cr
531+
\code{quiet} \tab \code{FALSE}\cr
530532
\code{scipen} \tab \code{0} \cr
531533
\code{show.error.messages} \tab \code{TRUE}\cr
532534
\code{timeout} \tab \code{60}\cr
533-
\code{quiet} \tab \code{FALSE}\cr
534535
\code{verbose} \tab \code{FALSE}\cr
535536
\code{warn} \tab \code{0}\cr
536537
\code{warning.length} \tab \code{1000}\cr
537538
\code{width} \tab \code{80}\cr
538539
}
539540
Others are set from environment variables or are platform-dependent.
540541
}
542+
541543
\section{Options set in package \pkg{grDevices}}{
542544
These will be set when package \pkg{grDevices} (or its namespace)
543545
is loaded if not already set.
@@ -820,6 +822,7 @@ local({
820822
821823
}
822824
}
825+
823826
\section{Options set in package \pkg{parallel}}{
824827
These will be set when package \pkg{parallel} (or its namespace)
825828
is loaded if not already set.

0 commit comments

Comments
 (0)