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

Polish upkeep bullets #1905

Merged
merged 14 commits into from
Oct 31, 2023
Merged

Polish upkeep bullets #1905

merged 14 commits into from
Oct 31, 2023

Conversation

hadley
Copy link
Member

@hadley hadley commented Oct 30, 2023

No description provided.

@hadley hadley requested a review from jennybc October 30, 2023 19:14
Comment on lines -147 to +153
todo("
`usethis::use_package_doc()`
Consider letting usethis manage your `@importFrom` directives here.
`usethis::use_import_from()` is handy for this."),
todo("
`usethis::use_testthat(3)` and upgrade to 3e, \\
[testthat 3e vignette](https://testthat.r-lib.org/articles/third-edition.html)"),
todo("
Align the names of `R/` files and `test/` files for workflow happiness.
The docs for `usethis::use_r()` include a helpful script.
`usethis::rename_files()` may be be useful."),
todo("`usethis::use_package_doc()`"),
todo("`usethis::use_testthat(3)`"),
todo("Align the names of `R/` files and `test/` files"),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, I like having detail, links, etc. But I can also imagine this is about making the items for the distant past more lean, yeah? And saving detail for the items we are more likely to be engaging with in the year of our lord 2023?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, exactly.

* [ ] Add alt-text to pictures, plots, etc; see https://posit.co/blog/knitr-fig-alt/ for examples

### Eternal
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea 💡

@@ -36,7 +36,7 @@
* [ ] Update email addresses *@rstudio.com -> *@posit.co
* [ ] Update copyright holder in DESCRIPTION: `person("Posit Software, PBC", role = c("cph", "fnd"))`
* [ ] `Run devtools::document()` to re-generate package-level help topic with DESCRIPTION changes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [ ] `Run devtools::document()` to re-generate package-level help topic with DESCRIPTION changes
* [ ] Run `devtools::document()` to re-generate package-level help topic with DESCRIPTION changes

Not in the diff but something I just noticed.

@hadley hadley merged commit 080aa14 into main Oct 31, 2023
13 checks passed
@hadley hadley deleted the upkeep-polishing branch October 31, 2023 12:11
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

Successfully merging this pull request may close these issues.

2 participants