David Dorchies
Reputation: 334
Roxygen2: Inherits examples tag from another function
Example inheritance is a feature introduced in Roxygen2 v6.1.0 (See https://github.com/r-lib/roxygen2/issues/588).
But I don't find the syntax that should be use to inherit @examples tag from another function. I tried the following:
@inheritExamples FunctionNamewhich leads to an "unknown tag" error@inherit FunctionName return examplesas explained here fordetailstag but it seems to have no effect
Does anyone know the correct syntax to use to inherit such tag?
Upvotes: 0
Views: 400
Answers (1)
David Dorchies
Reputation: 334
Oups! My bad. It seems that the second answer is the good one. I had refreshment issue in my documentation generation.
Upvotes: 1
Related Questions
- Using roxygen2 to inherit only certain parameters
- roxygen2: function not exported to NAMESPACE even after using @export
- How do I use roxygen to document a R package that includes a function with the same name?
- Inherit Roxygen2 documentation for multiple arguments in R package
- Can you share examples between functions with rOxygen2?
- Importing two functions with same name using roxygen2
- Is it possible to @inheritParams from a function within another package?
- R with roxygen2: How to use a single function from another package?
- Roxygen2 document dependency of a function
- R Roxygen link to parent function