Skip to content

@inherit Doesn't inherit description if not inheriting title #629

@ssokolen

Description

@ssokolen

This might be a feature rather than a bug, but the following doesn't seem to work as expected. Unless I include @inherit title, @inherit description doesn't work.

Original function:

#' This is title
#' 
#' This is description
#'
#' @param x x
#' @param y y
#'
#' @return numeric vector
f1 <- function(x, y) x + y

Function that will inherit f1:

#' Different title
#'
#' @inherit f1 description 
#'
#' @inheritParams f1
#' @param z z
#'
#' @inherit f1 return
f2 <-function(x, y, z) x + y + z

This results in \description{} of f2 to be: "Different title". If I modify the title to @inherit f1 title, the \description{} of f2 is correctly inherited as "This is description"

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions