Skip to content

Documenting multiple functions in the same file #590

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

Merged
hadley merged 1 commit into from
May 3, 2017
Merged

Documenting multiple functions in the same file #590

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion vignettes/rd.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ You can also inherit documentation from functions provided by another package by

### Documenting multiple functions in the same file

You can document multiple functions in the same file by using either `@rdname` or `@describeIn` tag. It's a technique best used with caution: documenting too many functions into one place leads to confusing documentation. It's best used when all functions have the same (or very similar) arguments.
You can document multiple functions in the same file by using either `@rdname` or `@describeIn` tag. It’s a technique best used with caution: documenting too many functions in one place leads to confusion. Use it when all functions have the same (or very similar) arguments.

`@describeIn` is designed for the most common cases:

Expand Down