docs: clarify separate directive lines - #8
Merged
Conversation
dbrattli
marked this pull request as ready for review
August 15, 2026 08:24
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Clarifies that each ADC directive line contains one directive and one statement, and that multiple decisions, invariants, assumptions, or tradeoffs should use separate lines.
Why
The existing examples imply this convention, but the format section did not state it explicitly. The clarification keeps annotations atomic and easier to review or process mechanically.
Validation
npx --yes markdownlint-cli2@0.23.2 --config .markdownlint.jsonc "**/*.md"git diff --checkrg '^#{1,6} ' README.md AGENTS.mdThis is documentation-only wording and does not change directive semantics.