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.

Sign up for GitHub

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

Jump to bottom

Documentation feedback: Difference between @rdname and @describeIn unclear in reuse.Rmd #1495

Closed
MichaelChirico opened this issue Jul 4, 2023 · 0 comments · Fixed by #1496
Closed

Documentation feedback: Difference between @rdname and @describeIn unclear in reuse.Rmd #1495

MichaelChirico opened this issue Jul 4, 2023 · 0 comments · Fixed by #1496
Labels
documentation

Comments

@MichaelChirico
Copy link
Contributor

Received this feedback from a user (related to #1493).

Scanning the document, I also don't see a clear distinction made between the two. There are several @describeIn examples, but the only @rdname examples are being used to highlight the @order feature.

IMO a ### `@rdname` subsection paralleling this for @describeIn would be appropriate:

roxygen2/vignettes/reuse.Rmd

Line 38 in a34bdf7

### `@describeIn`

At a minimum, linking out to a more complete description of the two tags would help.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add examples for @rdname to 'reuse' vignette MichaelChirico/roxygen2
2 participants
@hadley @MichaelChirico