The Component Clean Standard undercounts its own items

Table of Contents

This page is a capture in the inbox bucket of the product backlog — a pre-sprint idea, not yet pulled into a sprint as a story.

1. What

Correct the item count in the standard, and make the count checkable. The table under doc/knowledge/architecture/component_clean_standard.org holds 49 rows: B01 to B06, M01 to M10, P01 to P06, G01 to G08, W01 to W04, S01 and S02, H01 to H05, and V01 to V08. The prose under the table says 47, and says the five items the infrastructure survey added brought it there.

2. Why

The two items the count does not include are G08 and H05, and both apply to every component. A component working the standard from the count records 47 items and never reaches them. That is what happened to ores.nats: the task recorded 47 items, G08 and H05 were absent, and G08 is the item the first pass broke by deleting the namespace documentation header the item protects. The review round found it.

The count is a number in prose with nothing that reads it, so it drifts from the table it describes. Either the number goes, or a check counts the rows and compares.

3. References

  • doc/knowledge/architecture/component_clean_standard.org — the table and the prose that contradicts it.
  • Bring ores.nats to the clean standard — the task that followed the count and skipped the two items.

4. See also

Emacs 29.3 (Org mode 9.6.15)