Skip to content

List Abbreviations: Warnings Wrap Multiple Concepts #76

@mferguson-rpc

Description

@mferguson-rpc

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

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions