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

install_github() and friends should use ellipsis::check_dots_used() #2016

Closed
hadley opened this issue Mar 31, 2019 · 3 comments
Closed

install_github() and friends should use ellipsis::check_dots_used() #2016

hadley opened this issue Mar 31, 2019 · 3 comments

Comments

@hadley
Copy link
Member

hadley commented Mar 31, 2019

From @jennybc:

devtools::install_github() used to have a build_vignettes argument. But its current incarnation, now remotes::install_github(), does not have this argument. To build vignettes, we're supposed to do this:

devtools::install_github("foo/bar", build_opts = c("--no-resave-data", "--no-manual"))

as per #1896 (comment).

However lots of people still try to do install_github("foo/bar", build_vignettes = TRUE) and, no doubt, some of our own material probably shows this, i.e. hasn't been updated yet.

And because the signature of install_github() contains ..., their attempts just silently fail:

install_github(repo, ref = "master", subdir = NULL,
  auth_token = github_pat(), host = "api.github.com",
  dependencies = NA, upgrade = c("default", "ask", "always", "never"),
  force = FALSE, quiet = FALSE, build = TRUE,
  build_opts = c("--no-resave-data", "--no-manual",
  "--no-build-vignettes"), repos = getOption("repos"),
  type = getOption("pkgType"), ...)

install_github() needs to give a clear message if you've misspecified the argument names.

(I think this needs to wait until after I've added an option to check_dots_used() to throw a warning instead of an error; since install_github() is called primarily for its side-effects, I think throwing an error is confusing, since it would occur after the side-effects have taken place)

@gaborcsardi
Copy link
Member

@hadley remotes does not have any hard dependencies, and this is an important feature for some use cases.

@hadley
Copy link
Member Author

hadley commented Mar 31, 2019

Ok, then if we know that this will never be done in remotes, we can instead do it in devtools, so I'll move this issue there.

@lock
Copy link

lock bot commented Feb 28, 2020

This old issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with reprex) and link to this issue. https://reprex.tidyverse.org/

@lock lock bot locked and limited conversation to collaborators Feb 28, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants