Skip to content

Commit 35c1f37

Browse files
author
smeyer
committed
doc tweaks
git-svn-id: https://svn.r-project.org/R/trunk@87969 00db46b3-68df-0310-9c12-caf00c1e9a41
1 parent c43336b commit 35c1f37

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

src/library/base/man/options.Rd

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
% File src/library/base/man/options.Rd
22
% Part of the R package, https://www.R-project.org
3-
% Copyright 1995-2024 R Core Team
3+
% Copyright 1995-2025 R Core Team
44
% Distributed under GPL 2 or later
55

66
\name{options}
@@ -576,16 +576,16 @@ getOption(x, default = NULL)
576576
device is opened are used.}
577577
}
578578
}
579-
\section{Other options used by package graphics}{
579+
\section{Other options used by package \pkg{graphics}}{
580580
\describe{
581581
\item{\code{max.contour.segments}:}{positive integer, defaulting to
582582
\code{25000} if not set. A limit on the number of
583583
segments in a single contour line in \code{\link{contour}} or
584584
\code{\link{contourLines}}.}
585585
}
586586
}
587-
\section{Options set in package stats}{
588-
These will be set when package \pkg{stats} (or its namespace)
587+
\section{Options set (or used) in package \pkg{stats}}{
588+
Most of these will be set when package \pkg{stats} (or its namespace)
589589
is loaded if not already set.
590590
\describe{
591591
\item{\code{contrasts}:}{the default \code{\link{contrasts}} used in
@@ -604,11 +604,14 @@ getOption(x, default = NULL)
604604
\code{\link{printCoefmat}}.}
605605
606606
\item{\code{show.nls.convergence}:}{logical, should \code{\link{nls}}
607-
convergence messages be printed for successful fits?}
607+
convergence messages be printed for successful fits?
608+
Initially unset, which means \code{TRUE}.}
608609
609610
\item{\code{show.signif.stars}:}{logical, should stars be printed on
610611
summary tables of coefficients? See \code{\link{printCoefmat}}.}
611612
613+
\item{\code{str.dendrogram.last}:}{see \code{\link{str.dendrogram}}.}
614+
612615
\item{\code{ts.eps}:}{the relative tolerance for certain time series
613616
(\code{\link{ts}}) computations. Default \code{1e-05}.}
614617
@@ -617,9 +620,11 @@ getOption(x, default = NULL)
617620
\code{log} in \code{\link{plot.spec}}.}
618621
}
619622
}
620-
\section{Options set (or used) in package utils}{
621-
These will be set (apart from \code{Ncpus}) when package \pkg{utils}
622-
(or its namespace) is loaded if not already set.
623+
\section{Options set (or used) in package \pkg{utils}}{
624+
Many of these will be set when package \pkg{utils} (or its namespace)
625+
is loaded if not already set.
626+
% apart from, e.g., "ccaddress", "help.ports", "help_type",
627+
% "help.htmlmath", "help.htmltoc", "install.lock", "Ncpus"
623628
\describe{
624629
\item{\code{BioC_mirror}:}{The URL of a Bioconductor mirror
625630
for use by \code{\link{setRepositories}},
@@ -786,8 +791,6 @@ local({
786791
\item{\code{str}:}{a list of options controlling the default
787792
\code{\link{str}} display. Defaults to \code{\link{strOptions}()}.}
788793
789-
\item{\code{str.dendrogram.last}:}{see \code{\link{str.dendrogram}}.}
790-
791794
\item{\code{SweaveHooks}, \code{SweaveSyntax}:}{
792795
see \code{\link{Sweave}}.
793796
}
@@ -806,7 +809,7 @@ local({
806809
807810
}
808811
}
809-
\section{Options set in package parallel}{
812+
\section{Options set in package \pkg{parallel}}{
810813
These will be set when package \pkg{parallel} (or its namespace)
811814
is loaded if not already set.
812815
\describe{

0 commit comments

Comments
 (0)