guess_readme() matches a single README file #191
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #189 and fixes #190.
guess_readme()
now matches README.Rmd and README.md as well as their lower-/mixed-case variants (including readme.rmd which hasn't been matched before), but no other files such as README.Rmd~ or DO_NOT_README.md. The function either returns a singlereadme_path
orNULL
. I have added an appropriate test for this behaviour.In the rare event where there exist multiple mixed-case README.md files on Unix-alikes, the function returns the first match (which is locale-dependent). I have decided not to warn about that since codemetar is generally non-verbose about its guesses.
I've also added myself to the DESCRIPTION using
desc::desc_add_me()
as suggested by @maelle (#190 (comment)).