Skip to content

Commit

Permalink
Also NOTE invalid package aliases in Rd files.
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.r-project.org/R/trunk@84748 00db46b3-68df-0310-9c12-caf00c1e9a41
  • Loading branch information
hornik committed Jul 24, 2023
1 parent 9d2ec6d commit a8a3c4d
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions src/library/tools/R/QC.R
Original file line number Diff line number Diff line change
Expand Up @@ -8911,6 +8911,7 @@ function(package, dir, lib.loc = NULL)
readRDS(rds)
} # else NULL
} else {
package <- .get_package_metadata(dir)["Package"]
Rd_contents(Rd_db(dir = dir))
}

Expand Down Expand Up @@ -8939,8 +8940,25 @@ function(package, dir, lib.loc = NULL)
out$files_with_duplicated_aliases <-
files_with_duplicated_aliases

out$files_without_aliases <- files[nAliases == 0L]

files_without_aliases <- files[nAliases == 0L]
if(length(files_without_aliases))
out$files_without_aliases <- files_without_aliases

aliases <- unlist(aliases)
names(aliases) <- rep.int(files, nAliases) # again ...
all_package_aliases <- aliases[endsWith(aliases, "-package")]
the_package_alias <- sprintf("%s-package", package)
if(the_package_alias %in% all_package_aliases) {
## Be nice: package names in standard repositories are unique
## ignoring case.
all_package_aliases <-
all_package_aliases[tolower(all_package_aliases) !=
tolower(the_package_alias)]
}
if(length(all_package_aliases))
out$files_with_bad_package_aliases <-
split(all_package_aliases, names(all_package_aliases))

out
}

Expand All @@ -8967,6 +8985,14 @@ function(x, ...)
if(length(bad <- x$files_without_aliases)) {
c(gettext("Rd files without \\alias:"),
.pretty_format(bad))
},
if(length(bad <- x$files_with_bad_package_aliases)) {
unlist(lapply(names(bad),
function(nm) {
c(gettextf("Invalid package aliases in Rd file '%s':",
nm),
.pretty_format(bad[[nm]]))
}))
})
}

Expand Down

0 comments on commit a8a3c4d

Please sign in to comment.