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

@inheritDotDotDot #512

Closed
hadley opened this issue Sep 20, 2016 · 1 comment
Closed

@inheritDotDotDot #512

hadley opened this issue Sep 20, 2016 · 1 comment
Labels
feature a feature request or enhancement

Comments

@hadley
Copy link
Member

hadley commented Sep 20, 2016

Generate documentation for the ... parameter by including (selected?) parameters from another function. See ?plot for an example of how this should render.

Not sure how you should specify which arguments to include in the list, since in many cases you won't want to include them all.

@hadley hadley added the feature a feature request or enhancement label Sep 20, 2016
@hadley hadley closed this as completed in ba70629 Sep 21, 2016
@privefl
Copy link

privefl commented Oct 2, 2016

Sorry if it's a stupid remark. From what I understood from NEWS.md, I tried to use

#' @inheritDotParams bigmemory::big.matrix
#' @inheritDocParams -nrow -ncol -type -init

and my first question was "why a Dot and a Doc?".
After some quick trial and error, I used

#' @inheritDotParams bigmemory::big.matrix -nrow -ncol -type -init

and it worked.
Am I missing some documentation?

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
Projects
None yet
Development

No branches or pull requests

2 participants