Skip to content

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

Closed

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}")

Activity

  1. added this to the v7.2.4 milestone on Nov 21, 2023
  2. added a commit that references this issue on Nov 21, 2023
    c537e9f
  3. added a commit that references this issue on Nov 22, 2023
    f4dc9b1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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