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

spell_check_package() to include NEWS and ChangeLog too #55

Open
HenrikBengtsson opened this issue Sep 14, 2020 · 2 comments
Open

spell_check_package() to include NEWS and ChangeLog too #55

HenrikBengtsson opened this issue Sep 14, 2020 · 2 comments

Comments

@HenrikBengtsson
Copy link

spell_check_package() checks NEWS.md but not plain-text NEWS files. Please consider adding that. It's probably as simple as adding NEWS to the list of files recognized.

@HenrikBengtsson
Copy link
Author

In addition to NEWS, there's also the ChangeLog file that's officially acknowledged by R, cf. WRE. One may also wanna include LICENSE and LICENCE here.

It's the following file grep pattern that needs to be updated:

spelling/R/spell-check.R

Lines 77 to 78 in fc619ee

root_files <- list.files(pkg$path, pattern = "(readme|news|changes|index).r?md",
ignore.case = TRUE, full.names = TRUE)

Related: BTW, that reg expr should probably also be protected with a trailing $ to avoid pickup up for instance *.md~ backup files. Also, the period can be escaped, e.g. \\. or [.].

@HenrikBengtsson HenrikBengtsson changed the title spell_check_package() to include NEWS too spell_check_package() to include NEWS and ChangeLog too Nov 2, 2020
@ethanplunkett
Copy link

Possibly consider allowing users to specify a list of non-standard files to add to the check via a file analogous to ./inst/WORDLIST. This would be a compliment of #63 (excluding specific files).

I came here hoping to find a way of adding ./.github/CONTRIBUTING.md but imagine there might be lots of package specific files. One of my package has some template markdown files in ./inst/ that are unique to it.

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

2 participants