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

Common config files that should not be spell checked #317

Merged
merged 8 commits into from
Nov 26, 2021

Conversation

bart1
Copy link
Contributor

@bart1 bart1 commented Nov 23, 2021

In R projects/packages I commonly have a gitlab ci/cd and pkgdown configuration file. I think these should not be spell checked therefore these suggestions for the defaults of the config files

@bart1
Copy link
Contributor Author

bart1 commented Nov 23, 2021

I now realize .lintr might be an other file to consider

@lorenzwalthert
Copy link
Owner

Hi @bart1, thanks for your suggestions. I agree in the lintr spec file, but in my experience, pkgdown should contain very few special words apart from plain English and the names of the functions in your package. the text specified in that file is also user visible to a large extend, so I think we best don’t exclude it. The gitlab ci i am happy to add to the template. Note though that the listed refer are alphabetically ordered. Please adjust that.

Also, note that you can override the config in this repo in your own .pre-commit-config.yaml.

@bart1
Copy link
Contributor Author

bart1 commented Nov 26, 2021

@lorenzwalthert Thank you for your suggestions, I have updated the merge request accordingly.
ps I do indeed make these changes in my own .pre-commit-config.yaml I was however I was making the same changes in multiple repositories and thought these might be better defaults

@lorenzwalthert
Copy link
Owner

lorenzwalthert commented Nov 26, 2021

@bart1 I see. You can also set an R option to use a local or remote config template by default, see argument config_source in precommit::use_precommit().

@lorenzwalthert lorenzwalthert merged commit ffb10a1 into lorenzwalthert:main Nov 26, 2021
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.

None yet

2 participants