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

Roxygen2 lets functions inherit parameter documentation across functions #96

Open
antongrau opened this issue Jan 4, 2016 · 0 comments
Labels

Comments

@antongrau
Copy link
Member

"You can inherit parameter descriptions from other functions using @inheritParams source_function. This tag will bring in all documentation for parameters that are undocumented in the current function, but documented in the source function. The source can be a function in the current package, via @inheritParams function, or another package, via @inheritParams package::function"

See: http://r-pkgs.had.co.nz/man.html

This should be applied to all map.functions

@antongrau antongrau added the Docs label Jan 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant