base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Record flag naming decision and diagnostic adapter analysis

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-07 14:40:52 +00:00
parent 9d4c963c53
commit 2a93b45419
2 changed files with 55 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/roadmap/audit/catalog.md
View File

@@ -169,13 +169,19 @@ spelling, while installation enforces additional name grammar and reserved
spellings. Consumers must discover those constraints through errors or private
implementation.
Document the implemented rules once with `FlagMeta` and link related public
helpers. Preserve accepted Unicode lowercase letters and digits; changing
validation would require a separate decision.
**Decision:** retain and document the existing declaration rules. Long names use
Unicode lowercase letters and digits separated by single hyphens; numeric names
and names beginning with digits remain allowed. Keep core-owned reserved names
and the optional one-byte short-spelling rules, excluding `-` and reserved `h`.
Do not add ASCII-only or leading-letter restrictions, or automatic rewriting of
invalid names. These rules concern flag names, not supplied values.
Document the rules once with `FlagMeta` and link related public helpers. This
remediation changes documentation, not runtime validation.
The [F10 analysis](remediation-analysis.md#f10--flag-declaration-naming) reviews
the naming convention's basis and recommends retaining the existing rules;
agreement on that precise contract is pending.
the naming convention's basis and records the accepted direction. Implementation
of the documentation correction remains pending.
**Original:** [13-documentation D2](13-documentation.md#d2--p3-public-flag-metadata-omits-enforced-declaration-constraints).