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

audit for backticked package names #218

Closed
simonpcouch opened this issue Jul 22, 2024 · 0 comments · Fixed by #224
Closed

audit for backticked package names #218

simonpcouch opened this issue Jul 22, 2024 · 0 comments · Fixed by #224
Labels
documentation tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day

Comments

@simonpcouch
Copy link
Collaborator

In many places in stacks, the package name is written "stacks" rather than "stacks" (i.e. there are backticks before and after). Per tidy style, package names don't need backticks.

Here's an example GitHub search:

https://github.com/search?q=repo%3Atidymodels%2Fstacks%20%22%60stacks%60%22&type=code

Let's search for tidymodels and tidyverse package names and make sure they're not backticked.

The part that makes this a little more tricky than a Find and Replace is knowing when the thing should actually be backticked vs. not. If the text is definitely referencing stacks as a package, take the backticks away. If there's e.g. a reference to the stacks() function rather than the package stacks, leave it as is (making sure to include parentheses following function names if needed). Be sure to devtools::document() and/or devtools::build_readme() before putting in the PR!

@simonpcouch simonpcouch added tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day documentation labels Jul 22, 2024
@simonpcouch simonpcouch linked a pull request Aug 15, 2024 that will close this issue
Joscelinrocha added a commit to Joscelinrocha/stacks that referenced this issue Aug 15, 2024
Added missing commas and formatting issues throughout the vignettes and articles. Backticks for package names were removed, and missing parentheses for functions were added.

These changes fix issue tidymodels#218
@simonpcouch simonpcouch linked a pull request Aug 15, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day
Projects
None yet
1 participant