[checks] Add check for `\pnum Implementations should`
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 221
- Forks
- 813
- Avg merge
- 16h 4m
- Merged PRs (30d)
- 36
Description
We have a surprising amount of violations of the form
\pnum
Implementations should ...
I'm pretty sure that every one of those ought to be
\pnum
\recommended
Implementations should ...
There are also some "Implementations should" inside of notes and examples, which may be a bit undesirable, but it's not obvious whether or how to fix those cases. It's also harder to detect/fix the cases where "Implementations should" appears in some longer paragraph.
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
The issue names no checker file or test. Start by locating the repository's existing checks for TeX source patterns, then inspect how they handle \pnum and \recommended. Done means the check reliably flags direct "Implementations should" paragraphs while leaving notes, examples, and longer paragraphs outside the stated scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100