Skip to content

Commit bdf3150

Browse files
author
smeyer
committed
mention (donttest-alike) demos at more places
git-svn-id: https://svn.r-project.org/R/trunk@88012 00db46b3-68df-0310-9c12-caf00c1e9a41
1 parent 4a0020c commit bdf3150

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/manual/R-exts.texi

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -921,12 +921,12 @@ checked when the namespace is loaded.
921921
@c DESCRIPTION field Suggests
922922
The @samp{Suggests} field uses the same syntax as @samp{Depends} and
923923
lists packages that are not necessarily needed. This includes packages
924-
used only in examples, tests or vignettes (@pxref{Writing package
924+
used only in examples, demos, tests or vignettes (@pxref{Writing package
925925
vignettes}), and packages loaded in the body of functions. E.g.,
926-
suppose an example@footnote{even one wrapped in @code{\donttest}.} from
926+
suppose an example@footnote{even one wrapped in @code{\donttest}, or a demo script.} from
927927
package @pkg{foo} uses a dataset from package @pkg{bar}. Then it is not
928-
necessary to have @pkg{bar} use @pkg{foo} unless one wants to execute
929-
all the examples/tests/vignettes: it is useful to have @pkg{bar}, but
928+
necessary to have @pkg{bar} to use @pkg{foo} unless one wants to execute
929+
all the examples: it is useful to have @pkg{bar}, but
930930
not necessary. Version requirements can be specified but should be
931931
checked by the code which uses the package.
932932

@@ -981,7 +981,7 @@ Packages needed to use datasets from the package should be in
981981
@end itemize
982982

983983
@noindent
984-
In particular, packages providing ``only'' data for examples or
984+
In particular, packages providing ``only'' data for examples, demos or
985985
vignettes should be listed in @samp{Suggests} rather than @samp{Depends}
986986
in order to make lean installations possible.
987987

@@ -1400,8 +1400,8 @@ The @file{demo} subdirectory is for @R{} scripts (for running @emph{via}
14001400
@code{demo()}) that demonstrate some of the functionality of the
14011401
package. Demos may be interactive and are not checked
14021402
automatically@footnote{As from @R{} 4.5.0, @code{R CMD check} can be
1403-
invoked with option @option{--run-demo} to check demos like @file{tests},
1404-
including comparisons with optional reference outputs in
1403+
invoked with option @option{--run-demo} to check demos analogously to
1404+
@file{tests}, including comparisons with optional reference outputs in
14051405
@file{.Rout.save} files.}, so
14061406
if testing is desired use code in the @file{tests} directory to achieve
14071407
this. The script files must start with a (lower or upper case) letter
@@ -1486,7 +1486,7 @@ file for running the examples when the latter are checked. Reference
14861486
output should be produced without having the @option{--timings} option
14871487
set (and note that @option{--as-cran} sets it).
14881488

1489-
If reference output is included for examples, tests or vignettes do make
1489+
If reference output is included for examples, demos, tests or vignettes do make
14901490
sure that it is fully reproducible, as it will be compared verbatim to
14911491
that produced in a check run, unless the @samp{IGNORE_RDIFF} markup is
14921492
used. Things which trip up maintainers include displayed version
@@ -5717,8 +5717,8 @@ provided you have Ghostscript available (see the help for
57175717
There are several ways to find out where time is being spent in the
57185718
check process. Start by setting the environment variable
57195719
@env{_R_CHECK_TIMINGS_} to @samp{0}. This will report the total CPU
5720-
times (not Windows) and elapsed times for installation and running
5721-
examples, tests and vignettes, under each sub-architecture if
5720+
times (not Windows) and elapsed times for installation and several checks,
5721+
including for running examples, tests and vignettes, under each sub-architecture if
57225722
appropriate. For tests and vignettes, it reports the time for each as
57235723
well as the total.
57245724

0 commit comments

Comments
 (0)