ietf-tools / ietf-tools/draftforge

List Abbreviations: Warnings Wrap Multiple Concepts

Open
#76 0 comments 0 reactions 1 assignee View on GitHub

@NGPixel is already working on this.

Since Jun 4, 2026.

enhancement
Dominant language
JavaScript
Stars
12
Forks
8
PR merge metrics
No merged PRs in 30d

Description

It is sometimes difficult to discern what the actual warning is about on a quick glance as the concepts of expansion match to the abbreviations list, use before expansion, single use, etc. are all rolled into the output. Additionally, Issue #53 means that many abbreviations are marked as not expanded when their expansion doesn't math the list (but an expansion exists) (which will hopefully resolve some issues with the warnings.)

Thus, it would be lovely to mimic the tiered structure that occurs if a document has two different expansions for the same abbreviation for all abbreviations -- where:

  • the top line is just if/how the abbreviation is expanded in the document.
  • another tier describes whether or not that matches the abbreviations list.
  • then sub-entries give warnings about abbreviations used "two times before expansion" or "only used once in the document", etc.

In this way, the editor can see action items at a quick glance and could quickly spot small mismatches with the abbreviations list (e.g., this doc uses Certificate Authority while the list has Certification Authority).

See attached screenshot for visual brainstorm.

Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.