Use "must" instead of "should" in error messages
Open
Nobody has claimed this yet.
feature
tidy-dev-day :nerd_face:
- Dominant language
- R
- Stars
- 117
- Forks
- 36
- Avg merge
- 1h 53m
- Merged PRs (30d)
- 2
Description
If we throw an error, things actually must be what is required, not just should, so let's remove that ambiguity in the wording. The rlang type checkers also use "must" so that's added consistency.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Search the repository for error messages using “should”, identify the messages intended by this issue, and run the relevant test suite after changing their wording to “must”; done means the targeted messages consistently use the required wording without breaking tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100