Closed
Description
I find the @inheritSection
and @inherit
tags quite convenient! However one restriction that they have is that it is not possible to change the name of the section that is inherited. It would be great if this was possible.
Let's say I have some documentation as below:
#' @title Hello world
#' @description
#' Greets the world
#' @export
hello_world = function() {
print("Hello world!")
}
I would like to be able to create another function g
that inherits the roxygen2 @description content from function f
, but under a different (section) name. I image this to work something like below:
#' @title Hello world
#' @description
#' Calls function `hello_world`, see section *hello world* for more information.
#' @inherit hello_world description: hello world
#' Greets the world
#' @export
g = function() {
hello_world()
}
Metadata
Metadata
Assignees
Labels
No labels