Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
MichaelChirico opened this issue Jun 30, 2023 · 0 comments · Fixed by #1547
Closed

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

MichaelChirico opened this issue Jun 30, 2023 · 0 comments · Fixed by #1547
Labels
feature a feature request or enhancement rd ✍️
Milestone

Comments

@MichaelChirico
Copy link
Contributor

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

@hadley hadley added feature a feature request or enhancement rd ✍️ labels Nov 1, 2023
@hadley hadley added this to the v7.2.4 milestone Nov 21, 2023
hadley added a commit that referenced this issue Nov 21, 2023
And provide a helpful suggestion for `@describeIn`. Fixes #1493.
hadley added a commit that referenced this issue Nov 22, 2023
And provide a helpful suggestion for `@describeIn`. Fixes #1493.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement rd ✍️
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants