docs: specifically disallow periods in error messages #5753
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5753 +/- ##
=======================================
Coverage 96.25% 96.25%
=======================================
Files 475 475
Lines 38475 38475
Branches 5587 5587
=======================================
Hits 37036 37036
Misses 1397 1397
Partials 42 42 ☔ View full report in Codecov by Sentry. |
kt3k
reviewed
Aug 21, 2024
.github/CONTRIBUTING.md
Outdated
| @@ -245,11 +245,10 @@ Bad: Can't parse input x | |||
| Good: Cannot parse input x | |||
| ``` | |||
|
|
|||
| 7. Messages should use a colon when providing additional information: | |||
| 7. Messages should not use a period when providing additional information: | |||
There was a problem hiding this comment.
I feel this obscures that we prefer colon. Can we mention both colon and period?
There was a problem hiding this comment.
Updated it to read:
7. Messages should use a colon when providing additional information. Periods
should never be used. Other punctuation may be used as needed:
Error messages should not include a period, as it will result in multiple sentences. Colons are the preferred punctuation but other punctuation may make sense in some cases.
irbull
force-pushed
the
err-msg-periods
branch
from
653551b
to
942ae65
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Error messages should not include a period, as it will result in multiple sentences. Colons are the preferred punctuation but other punctuation may make sense in some cases.