Skip to content

Commit

Permalink
remove note about package docs problems (#1933)
Browse files Browse the repository at this point in the history
* Update documentation.R

* Document

---------

Co-authored-by: jennybc <jennybc@users.noreply.github.com>
  • Loading branch information
olivroy and jennybc authored Jan 11, 2024
1 parent 709f825 commit 5986ab6
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 25 deletions.
12 changes: 0 additions & 12 deletions R/documentation.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,6 @@
#' good place for roxygen directives that apply to the whole package (vs. a
#' specific function), such as global namespace tags like `@importFrom`.
#'
#' There is one tricky case: when a **package** named "foo" also has a
#' **function** named `foo()`. In this case, after running `use_package_doc()`,
#' there will be an `R CMD check` warning. The solution is to set the `@aliases`
#' for the package-level help topic by modifying the dummy `.R` file (e.g.,
#' `foo-package.R`) as shown below (but substitute the name of your package /
#' function for "foo"):
#'
#' ```
#' #' @keywords internal
#' #' @aliases foo-package
#' #' "_PACKAGE"
#' ```
#' @seealso The [documentation chapter](https://r-pkgs.org/man.html) of [R
#' Packages](https://r-pkgs.org)
#' @inheritParams use_template
Expand Down
13 changes: 0 additions & 13 deletions man/use_package_doc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5986ab6

Please sign in to comment.