Skip to content

Commit

Permalink
checkDocFiles() for unaliased usages also in <pkg>-deprecated overviews
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.r-project.org/R/trunk@87273 00db46b3-68df-0310-9c12-caf00c1e9a41
  • Loading branch information
smeyer committed Oct 26, 2024
1 parent 7b80b5e commit 7c8a9c5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/NEWS.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -277,8 +277,8 @@
Strings markaed as \code{"bytes"} now give a warning rather than a
NOTE. These are better supplied as raw vectors.
\item \code{tools::checkDocFiles()} now also notes \emph{nullary}
functions shown in the usage section without corresponding \verb{\alias}.
\item \code{tools::checkDocFiles()} notes more cases of
usage documentation without corresponding \verb{\alias}.
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/library/tools/R/QC.R
Original file line number Diff line number Diff line change
Expand Up @@ -1526,12 +1526,12 @@ function(package, dir, lib.loc = NULL, chkInternal = NULL)
}

## Also test whether the objects we found from the \usage all
## have aliases, provided no alias ends in '-deprecated'.
## have aliases, provided not all aliases end in '-deprecated'.
## This exception allows packages to keep the original help page of a
## deprecated function at help("<fun>-deprecated") (see ?deprecated)
## and alias <fun> to help("<pkg>-deprecated").
functions_not_in_aliases <-
if(!any(endsWith(aliases, "-deprecated"))) {
if(!all(endsWith(aliases, "-deprecated"))) {
## Argh. There are good reasons for keeping \S4method{}{}
## as is, but of course this is not what the aliases use ...
## <FIXME>
Expand Down

0 comments on commit 7c8a9c5

Please sign in to comment.