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

use of the help argument in with_package #94

Closed
moodymudskipper opened this issue May 29, 2019 · 1 comment · Fixed by #128
Closed

use of the help argument in with_package #94

moodymudskipper opened this issue May 29, 2019 · 1 comment · Fixed by #128
Labels
tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day

Comments

@moodymudskipper
Copy link

The help argument of with_package is not documented explicitly :

help
the name of a package, given as a name or literal character string, or a character string, depending on whether character.only is FALSE (default) or TRUE).

To understand what it does I looked into the code and saw it was just forwarded to library, there I read the same argument description in ?library but the details say :

library(help = somename) computes basic information about the package somename, and returns this in an object of class "packageInfo".

Does it make sense having this argument in with_package ?

Moreover help has no default value while other arguments that didn't have a default value in library have one in with_package. Wouldn't it be more consistent (and tidy) to have a default value for help as well (if it makes sense to keep the argument).

@jimhester
Copy link
Member

The code currently forwards all arguments from library(), but you are correct forwarding help doesn't make a lot of sense, and confuses the issue. I think we can simply remove the argument from with_package().

@jimhester jimhester added the tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day label Jun 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants