docs: use ADR-NNNN in the conflict example so the citation check does not resolve it - #44
Merged
Merged
Conversation
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
docs/agents/domain.mdshows how to flag an ADR conflict with the example_Contradicts ADR-0007 (event-sourced orders)…_. The number becomes the placeholderADR-NNNN.Why
modern-python/.github#120 made the shared ADR citation check resolve bare
ADR-NNNNnumbers againstdocs/adr/.ADR-0007in this example is illustrative, names no record here, and would be reported as a broken citation.NNNNis not a number, so it is not a citation. The example reads the same.Verified
The current shared check run against this repo with the change: 9 passed (1 failed before).