Skip to content

User-friendliness: point to @rdname from @describeIn error (and vice versa?) #1493

@MichaelChirico

Description

@MichaelChirico

I see a lot of code like this:

#' @describeIn foo

Almost always this means the user intended #' @rdname foo, but the corresponding roxygenize() warning is not very helpful:

@describeIn requires name and description

Unfortunately it's not fully trivial to make this change since the error is coming from a more generalized piece of code:

warn_roxy_tag(x, "requires {first} and {second}")

Metadata

Metadata

Assignees

No one assigned

    Labels

    featurea feature request or enhancementrd ✍️

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions