From b2e79fa3e6628922bf04bc38e10b6a34ccbfbddc Mon Sep 17 00:00:00 2001 From: Michael Ramos Date: Wed, 17 Jun 2026 18:06:34 -0700 Subject: [PATCH] Fix ADR documentation typos MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Batch upstream typo/documentation fixes from npryce/adr-tools#137, #116, and #75. Co-authored-by: Frank Burger Co-authored-by: Alice Rühl Co-authored-by: David de Boer Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com> --- README.md | 9 ++++--- doc/adr/0004-markdown-format.md | 2 +- src/_adr_help_new | 24 ++++++++--------- src/adr-generate | 2 +- src/adr-new | 36 +++++++++++++------------- tests/generate-graph.expected | 8 +++--- tests/supercede-existing-adr.expected | 4 +-- tests/supercede-multiple-adrs.expected | 8 +++--- 8 files changed, 48 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 62ee894..1970ab2 100644 --- a/README.md +++ b/README.md @@ -31,15 +31,18 @@ when you initialise the ADR log. editor of choice (as specified by the VISUAL or EDITOR environment variable). - To create a new ADR that supercedes a previous one (ADR 9, for example), + To create a new ADR that supersedes a previous one (ADR 9, for example), use the -s option. adr new -s 9 Use Rust for performance-critical functionality - This will create a new ADR file that is flagged as superceding + This will create a new ADR file that is flagged as superseding ADR 9, and changes the status of ADR 9 to indicate that it is - superceded by the new ADR. It then opens the new ADR in your + superseded by the new ADR. It then opens the new ADR in your editor of choice. + + If the ADR directory contains a file `templates/template.md`, this is used + as the template for the new ADR. Otherwise a default template is used. 3. For further information, use the built in help: diff --git a/doc/adr/0004-markdown-format.md b/doc/adr/0004-markdown-format.md index 160d168..81e0a94 100644 --- a/doc/adr/0004-markdown-format.md +++ b/doc/adr/0004-markdown-format.md @@ -13,7 +13,7 @@ The decision records must be stored in a plain text format: * This works well with version control systems. * It allows the tool to modify the status of records and insert - hyperlinks when one decision supercedes another. + hyperlinks when one decision supersedes another. * Decisions can be read in the terminal, IDE, version control browser, etc. diff --git a/src/_adr_help_new b/src/_adr_help_new index 07c0968..7ec3b69 100755 --- a/src/_adr_help_new +++ b/src/_adr_help_new @@ -3,7 +3,7 @@ set -e eval "$($(dirname $0)/adr-config)" cat < $dstfile -for target in "${superceded[@]}" +for target in "${superseded[@]}" do - "$adr_bin_dir/_adr_add_link" "$target" "Superceded by" "$dstfile" + "$adr_bin_dir/_adr_add_link" "$target" "Superseded by" "$dstfile" "$adr_bin_dir/_adr_remove_status" "Accepted" "$target" - "$adr_bin_dir/_adr_add_link" "$dstfile" "Supercedes" "$target" + "$adr_bin_dir/_adr_add_link" "$dstfile" "Supersedes" "$target" done for l in "${links[@]}" @@ -124,7 +124,7 @@ do target="$(echo $l | cut -d : -f 1)" forward_link="$(echo $l | cut -d : -f 2)" reverse_link="$(echo $l | cut -d : -f 3)" - + "$adr_bin_dir/_adr_add_link" "$dstfile" "$forward_link" "$target" "$adr_bin_dir/_adr_add_link" "$target" "$reverse_link" "$dstfile" done diff --git a/tests/generate-graph.expected b/tests/generate-graph.expected index 8d928c9..c4566c8 100644 --- a/tests/generate-graph.expected +++ b/tests/generate-graph.expected @@ -23,8 +23,8 @@ digraph { _5 [label="5. The end"; URL="0005-the-end.html"]; _4 -> _5 [style="dotted", weight=1]; } - _3 -> _2 [label="Supercedes", weight=0] - _5 -> _3 [label="Supercedes", weight=0] + _3 -> _2 [label="Supersedes", weight=0] + _5 -> _3 [label="Supersedes", weight=0] } # with specified root and extension in links adr generate graph -p http://example.com/ -e .xxx @@ -41,6 +41,6 @@ digraph { _5 [label="5. The end"; URL="http://example.com/0005-the-end.xxx"]; _4 -> _5 [style="dotted", weight=1]; } - _3 -> _2 [label="Supercedes", weight=0] - _5 -> _3 [label="Supercedes", weight=0] + _3 -> _2 [label="Supersedes", weight=0] + _5 -> _3 [label="Supersedes", weight=0] } diff --git a/tests/supercede-existing-adr.expected b/tests/supercede-existing-adr.expected index cf61ae7..8a53a7a 100644 --- a/tests/supercede-existing-adr.expected +++ b/tests/supercede-existing-adr.expected @@ -9,7 +9,7 @@ Date: 1992-01-12 ## Status -Superceded by [2. Second Record](0002-second-record.md) +Superseded by [2. Second Record](0002-second-record.md) ## Context @@ -22,7 +22,7 @@ Date: 1992-01-12 Accepted -Supercedes [1. First Record](0001-first-record.md) +Supersedes [1. First Record](0001-first-record.md) ## Context diff --git a/tests/supercede-multiple-adrs.expected b/tests/supercede-multiple-adrs.expected index 89cbb93..474c172 100644 --- a/tests/supercede-multiple-adrs.expected +++ b/tests/supercede-multiple-adrs.expected @@ -11,7 +11,7 @@ Date: 1992-01-12 ## Status -Superceded by [3. Third Record](0003-third-record.md) +Superseded by [3. Third Record](0003-third-record.md) head -8 doc/adr/0002-second-record.md # 2. Second Record @@ -20,7 +20,7 @@ Date: 1992-01-12 ## Status -Superceded by [3. Third Record](0003-third-record.md) +Superseded by [3. Third Record](0003-third-record.md) head -12 doc/adr/0003-third-record.md # 3. Third Record @@ -31,7 +31,7 @@ Date: 1992-01-12 Accepted -Supercedes [1. First Record](0001-first-record.md) +Supersedes [1. First Record](0001-first-record.md) -Supercedes [2. Second Record](0002-second-record.md) +Supersedes [2. Second Record](0002-second-record.md)