Skip to content

Commit 77cea26

Browse files
author
smeyer
committed
document "unaliased" check
git-svn-id: https://svn.r-project.org/R/trunk@87262 00db46b3-68df-0310-9c12-caf00c1e9a41
1 parent 9a32d6b commit 77cea26

File tree

1 file changed

+5
-3
lines changed
  • src/library/tools/man

1 file changed

+5
-3
lines changed

src/library/tools/man/QC.Rd

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

66
\name{QC}
@@ -49,8 +49,10 @@ nonS3methods(package)
4949
}
5050
\details{
5151
\code{checkDocFiles} checks, for all Rd files in a package, whether all
52-
arguments shown in the usage sections of the Rd file are documented in
53-
its arguments section. It also reports duplicated entries in the
52+
functions shown in the usage section of the Rd file have a corresponding
53+
\verb{\alias},%(except if any ends with \samp{-deprecated})
54+
and all of their arguments are documented in
55+
the arguments section. It also reports duplicated entries in the
5456
arguments section, and \sQuote{over-documented} arguments which are
5557
given in the arguments section but not in the usage.
5658

0 commit comments

Comments
 (0)