ietf-tools / ietf-tools/draftforge
Hyphenation Check: Verbose Output / Warnings
@NGPixel is already working on this.
Since Jun 4, 2026.
- Dominant language
- JavaScript
- Stars
- 12
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
My very short doc (draft-ietf-emu-eap-arpa-10) had 12 warnings about the same inconsistency:
-11 warnings that “username is an alternate of user-name”, and 1 that “user-name is an alternate of username”.
Using grep, I can see that the doc itself uses the term 16 times:
username 9 times
“username” 1 time
Username 1 time
User-Name 1 time
User-Names 1 time
utf8-username 3 times
(See other issues related to the mismatch in numbers.)
This is really only one term inconsistency in this short doc -- and it has enough warnings to have to scroll to get through them and has them listed as if they were two different terms (user-name is alternate to username vs. username is alternate to user-name).
The warnings might be more useful if they were a summary-collapsible top line and then a drop-down with the instances you can click on? And can these be wrapped into 1 (user-name is alternate to username AND username is alternate to user-name)? Especially for a mega-doc, it might be a lot easier to get through…something like:
username is alternate of user-name (11 / 2)
-username Line 181 Col 52
-user-name Line 241 Col 19
As it currently outputs, this renders the output useless in some cases (i.e., too many hits for possibly zero action items).
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.
Assessment
This issue has not been assessed yet.