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

badge_github_version: change pkg arg to ref #48

Open
bschilder opened this issue Jan 12, 2023 · 0 comments
Open

badge_github_version: change pkg arg to ref #48

bschilder opened this issue Jan 12, 2023 · 0 comments

Comments

@bschilder
Copy link

Hi again,

This is a minor thing, but I found it about confusing until I looked into the code.

badge_github_version take the argument pkg:

pkg | package. If NULL (the default) the package is determined via the DESCRIPTION file.

but I think it actually means something closer to ref, as implemented in functions like badger::badge_github_actions:

## produces wrong link
badger::badge_github_version(pkg="rworkflows")

## produces correct link
badger::badge_github_version(pkg="neurogenomics/rworkflows")

If you agree, should be a simple fix to change the arg name to ref, and update the argument description accordingly.

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