Skip to content

Update styling commands to work similarly across systems #55

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

Closed
Tracked by #90
brookslogan opened this issue Oct 25, 2022 · 4 comments
Closed
Tracked by #90

Update styling commands to work similarly across systems #55

brookslogan opened this issue Oct 25, 2022 · 4 comments
Labels
P3 very low priority

Comments

@brookslogan
Copy link
Contributor

brookslogan commented Oct 25, 2022

styler::style_pkg() appears to be inconsistent about formatting vignettes. I've tried on my system with CRAN and GitHub versions of styler, and they don't seem to format the vignettes, and CI complains about that. [I just needed to start a new session after upgrading styler.]

@brookslogan
Copy link
Contributor Author

brookslogan commented Oct 25, 2022

Since CI seems to be running off of the GitHub version, this means that we need to update the dev dependency installation to use that version rather than CRAN. Maybe install.packages("devtools") + devtools::install_dev_deps().

@brookslogan
Copy link
Contributor Author

Might be worth a line in the README explaining this sort of situation; if CI complains about styling it suggests that the dev needs to upgrade to latest CRAN styler and style_pkg() in a fresh session.

@brookslogan
Copy link
Contributor Author

Also might note that styling should be followed by redocument()ing, as the styler can change example code, and those changes should be propagated to the Rd files.

@brookslogan brookslogan added the P3 very low priority label Oct 27, 2022
@dshemetov dshemetov mentioned this issue Aug 30, 2023
37 tasks
@dshemetov
Copy link
Contributor

dshemetov commented Aug 30, 2023

I added a couple CI actions to automatically handle these chores:

We also have the Makefile command make chores which will execute these commands in the right order.

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

No branches or pull requests

2 participants