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

What is the default for revdep_check(dependencies=), exactly? #381

Open
MichaelChirico opened this issue Oct 22, 2024 · 0 comments
Open

Comments

@MichaelChirico
Copy link

MichaelChirico commented Oct 22, 2024

#' release, we recommend using the default.

?revdep_check is not clear enough here IMO:

https://revdepcheck.r-lib.org/reference/revdep_check.html

In R, a signature like this is somewhat ambiguous:

dependencies = c("Depends", "Imports",
"Suggests", "LinkingTo"),

Because match.arg() often means "here's the enum of possible values, of which the first is chosen"; here that would mean "only downstream Depends are checked", which is "valid" but doesn't make that much sense. So I could guess that the default is "any downstream Depends, Imports, Suggests, or LinkingTo", but it would be better to be more explicit here.

It's not even clear to me from a minute of reading the sources what the behavior is -- I have to jump to another package entirely to understand what's going on. All the more reason to be explicit in the doc page here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant