Replace "warning" with "diagnostic", or define "warning"
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
In https://github.com/cplusplus/draft/pull/7728, @frederick-vs-ja pointed out that:
Hmm, the standard wording is currently saying "warning" for many times:
Ok fair point, I've drafted that PR when I was half-asleep after work and didn't find those for some reason. So it seems like (in N5001) we have:
- 27 occurrences of "warning" in the draft, of which 13 are in normative wording (the rest is comments,
#warning, etc.) - 134 occurrences of "diagnostic" in the draft, of which ... I'm not going to count lmao.
Unlike warning, "diagnostic" is a defined term [defns.diagnostic]. I think we should replace normative uses of "warning" with "diagnostic". To a casual reader, if we say "warning" in some places, that implies that some other messages are "errors", but the standard never makes that distinction. Even an ill-formed program isn't said to produce an "error message". It's all diagnostics.
To further clarify, I think it's fine to keep code comments such as:
0 = 0; // error
0 == 0; // warning
We use // error comments quite a bit despite never saying what an "error" is, but those uses aren't normative anyway. If "error" is fine in that context, so is "warning". It just isn't fine in normative wording.
Contributor guide
No contributing guide indexed for this repository
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
Search the draft for normative occurrences of “warning” and consult the [defns.diagnostic] definition linked in the issue. Distinguish normative wording from comments and #warning examples; done means each normative use is replaced with “diagnostic” or the term is explicitly defined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100