We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
I have a very weird bug. One of my files in a package is not picked up by roxygen2.
And I can't figure out why?
The class is actually created and exported. but there is no documentation.
It is this file https://github.com/ropensci/charlatan/blob/feat/rearrange_locale/R/person-provider.R
#' @title PersonProvider #' @details Methods for Persons, methods for generating names. #' @inherit BaseProvider note #' @family ParentProviders #' @export #' @returns A PersonProvider object that can create names. PersonProvider <- R6::R6Class( ...
What have I tried:
personprovidert.R
@rdname
@title
The text was updated successfully, but these errors were encountered:
You have a noRd here: https://github.com/ropensci/charlatan/blob/abe58cadf0a3fa9f97b045f6c004115ae86ca762/R/person-provider.R#L85
noRd
@noRd applies to the whole manual page.
@noRd
Sorry, something went wrong.
roxygen2 parses the #' comments until the end of the function (or object) definition. This can be quite handy when you want to keep the a piece of the manual page close to the code it documents. E.g. this is an example I like: https://github.com/r-lib/cli/blob/d8883112a8060c1f011cccc9147dd35db03bb9c6/R/num-ansi-colors.R#L37
#'
No branches or pull requests
I have a very weird bug.
One of my files in a package is not picked up by roxygen2.
And I can't figure out why?
The class is actually created and exported. but there is no documentation.
It is this file https://github.com/ropensci/charlatan/blob/feat/rearrange_locale/R/person-provider.R
What have I tried:
personprovidert.R
(because maybe the name is special?)@rdname
in stead of@title
The text was updated successfully, but these errors were encountered: