Skip to content

Commit d12659c

Browse files
ddeboerhalostatue
authored andcommitted
Fix spelling of 'supersede'
'supercede' is a misspelling of 'supersede': - https://www.merriam-webster.com/dictionary/supercede - https://en.wiktionary.org/wiki/supercede npryce#75
1 parent b3279ba commit d12659c

7 files changed

+44
-44
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ when you initialise the ADR log.
3333
editor of choice (as specified by the VISUAL or EDITOR environment
3434
variable).
3535

36-
To create a new ADR that supercedes a previous one (ADR 9, for example),
36+
To create a new ADR that supersedes a previous one (ADR 9, for example),
3737
use the -s option.
3838

3939
adr new -s 9 Use Rust for performance-critical functionality
4040

41-
This will create a new ADR file that is flagged as superceding
41+
This will create a new ADR file that is flagged as superseding
4242
ADR 9, and changes the status of ADR 9 to indicate that it is
43-
superceded by the new ADR. It then opens the new ADR in your
43+
superseded by the new ADR. It then opens the new ADR in your
4444
editor of choice.
4545

4646
3. For further information, use the built in help:

doc/adr/0004-markdown-format.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The decision records must be stored in a plain text format:
1313
* This works well with version control systems.
1414

1515
* It allows the tool to modify the status of records and insert
16-
hyperlinks when one decision supercedes another.
16+
hyperlinks when one decision supersedes another.
1717

1818
* Decisions can be read in the terminal, IDE, version control
1919
browser, etc.

src/_adr_help_new

+12-12
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ set -e
33
eval "$($(dirname $0)/adr-config)"
44

55
cat <<ENDHELP
6-
usage: adr new [-s SUPERCEDED] [-l TARGET:LINK:REVERSE-LINK] TITLE_TEXT...
6+
usage: adr new [-s SUPERSEDED] [-l TARGET:LINK:REVERSE-LINK] TITLE_TEXT...
77
88
Creates a new, numbered ADR. The TITLE_TEXT arguments are concatenated to
99
form the title of the new ADR. The ADR is opened for editing in the
@@ -23,32 +23,32 @@ This template follows the style described by Michael Nygard in this article.
2323
2424
Options:
2525
26-
-s SUPERCEDED A reference (number or partial filename) of a previous
27-
decision that the new decision supercedes. A Markdown link
28-
to the superceded ADR is inserted into the Status section.
29-
The status of the superceded ADR is changed to record that
30-
it has been superceded by the new ADR.
26+
-s SUPERSEDED A reference (number or partial filename) of a previous
27+
decision that the new decision supersedes. A Markdown link
28+
to the superseded ADR is inserted into the Status section.
29+
The status of the superseded ADR is changed to record that
30+
it has been superseded by the new ADR.
3131
3232
-l TARGET:LINK:REVERSE-LINK
33-
Links the new ADR to a previous ADR.
34-
TARGET is a reference (number or partial filename) of a
35-
previous decision.
33+
Links the new ADR to a previous ADR.
34+
TARGET is a reference (number or partial filename) of a
35+
previous decision.
3636
LINK is the description of the link created in the new ADR.
3737
REVERSE-LINK is the description of the link created in the
3838
existing ADR that will refer to the new ADR.
3939
40-
Multiple -s and -l options can be given, so that the new ADR can supercede
40+
Multiple -s and -l options can be given, so that the new ADR can supersede
4141
or link to multiple existing ADRs.
4242
4343
E.g. to create a new ADR with the title "Use MySQL Database":
4444
4545
adr new Use MySQL Database
4646
47-
E.g. to create a new ADR that supercedes ADR 12:
47+
E.g. to create a new ADR that supersedes ADR 12:
4848
4949
adr new -s 12 Use PostgreSQL Database
5050
51-
E.g. to create a new ADR that supercedes ADRs 3 and 4, and amends ADR 5:
51+
E.g. to create a new ADR that supersedes ADRs 3 and 4, and amends ADR 5:
5252
5353
adr new -s 3 -s 4 -l "5:Amends:Amended by" Use Riak CRDTs to cope with scale
5454

src/adr-new

+18-18
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
set -e
33
eval "$($(dirname $0)/adr-config)"
44

5-
## usage: adr new [-s SUPERCEDED] [-l TARGET:LINK:REVERSE-LINK] TITLE_TEXT...
5+
## usage: adr new [-s SUPERSEDED] [-l TARGET:LINK:REVERSE-LINK] TITLE_TEXT...
66
##
77
## Creates a new, numbered ADR. The TITLE_TEXT arguments are concatenated to
88
## form the title of the new ADR. The ADR is opened for editing in the
@@ -19,44 +19,44 @@ eval "$($(dirname $0)/adr-config)"
1919
##
2020
## Options:
2121
##
22-
## -s SUPERCEDED A reference (number or partial filename) of a previous
23-
## decision that the new decision supercedes. A Markdown link
24-
## to the superceded ADR is inserted into the Status section.
25-
## The status of the superceded ADR is changed to record that
26-
## it has been superceded by the new ADR.
22+
## -s SUPERSEDED A reference (number or partial filename) of a previous
23+
## decision that the new decision supersedes. A Markdown link
24+
## to the superseded ADR is inserted into the Status section.
25+
## The status of the superseded ADR is changed to record that
26+
## it has been superseded by the new ADR.
2727
##
2828
## -l TARGET:LINK:REVERSE-LINK
29-
## Links the new ADR to a previous ADR.
30-
## TARGET is a reference (number or partial filename) of a
31-
## previous decision.
29+
## Links the new ADR to a previous ADR.
30+
## TARGET is a reference (number or partial filename) of a
31+
## previous decision.
3232
## LINK is the description of the link created in the new ADR.
3333
## REVERSE-LINK is the description of the link created in the
3434
## existing ADR that will refer to the new ADR.
3535
##
36-
## Multiple -s and -l options can be given, so that the new ADR can supercede
36+
## Multiple -s and -l options can be given, so that the new ADR can supersede
3737
## or link to multiple existing ADRs.
3838
##
3939
## E.g. to create a new ADR with the title "Use MySQL Database":
4040
##
4141
## adr new Use MySQL Database
4242
##
43-
## E.g. to create a new ADR that supercedes ADR 12:
43+
## E.g. to create a new ADR that supersedes ADR 12:
4444
##
4545
## adr new -s 12 Use PostgreSQL Database
4646
##
47-
## E.g. to create a new ADR that supercedes ADRs 3 and 4, and amends ADR 5:
47+
## E.g. to create a new ADR that supersedes ADRs 3 and 4, and amends ADR 5:
4848
##
4949
## adr new -s 3 -s 4 -l "5:Amends:Amended by" Use Riak CRDTs to cope with scale
5050
##
5151

52-
superceded=()
52+
superseded=()
5353
links=()
5454

5555
while getopts s:l: arg
5656
do
5757
case "$arg" in
5858
s)
59-
superceded+=("$OPTARG")
59+
superseded+=("$OPTARG")
6060
;;
6161
l)
6262
links+=("$OPTARG")
@@ -112,19 +112,19 @@ cat $template | sed \
112112
-e "s|STATUS|Accepted|" \
113113
> $dstfile
114114

115-
for target in "${superceded[@]}"
115+
for target in "${superseded[@]}"
116116
do
117-
"$adr_bin_dir/_adr_add_link" "$target" "Superceded by" "$dstfile"
117+
"$adr_bin_dir/_adr_add_link" "$target" "Superseded by" "$dstfile"
118118
"$adr_bin_dir/_adr_remove_status" "Accepted" "$target"
119-
"$adr_bin_dir/_adr_add_link" "$dstfile" "Supercedes" "$target"
119+
"$adr_bin_dir/_adr_add_link" "$dstfile" "Supersedes" "$target"
120120
done
121121

122122
for l in "${links[@]}"
123123
do
124124
target="$(echo $l | cut -d : -f 1)"
125125
forward_link="$(echo $l | cut -d : -f 2)"
126126
reverse_link="$(echo $l | cut -d : -f 3)"
127-
127+
128128
"$adr_bin_dir/_adr_add_link" "$dstfile" "$forward_link" "$target"
129129
"$adr_bin_dir/_adr_add_link" "$target" "$reverse_link" "$dstfile"
130130
done

tests/generate-graph.expected

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ digraph {
2323
_5 [label="5. The end"; URL="0005-the-end.html"];
2424
_4 -> _5 [style="dotted", weight=1];
2525
}
26-
_3 -> _2 [label="Supercedes", weight=0]
27-
_5 -> _3 [label="Supercedes", weight=0]
26+
_3 -> _2 [label="Supersedes", weight=0]
27+
_5 -> _3 [label="Supersedes", weight=0]
2828
}
2929
# with specified root and extension in links
3030
adr generate graph -p http://example.com/ -e .xxx
@@ -41,6 +41,6 @@ digraph {
4141
_5 [label="5. The end"; URL="http://example.com/0005-the-end.xxx"];
4242
_4 -> _5 [style="dotted", weight=1];
4343
}
44-
_3 -> _2 [label="Supercedes", weight=0]
45-
_5 -> _3 [label="Supercedes", weight=0]
44+
_3 -> _2 [label="Supersedes", weight=0]
45+
_5 -> _3 [label="Supersedes", weight=0]
4646
}

tests/supercede-existing-adr.expected

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Date: 1992-01-12
99

1010
## Status
1111

12-
Superceded by [2. Second Record](0002-second-record.md)
12+
Superseded by [2. Second Record](0002-second-record.md)
1313

1414
## Context
1515

@@ -22,7 +22,7 @@ Date: 1992-01-12
2222

2323
Accepted
2424

25-
Supercedes [1. First Record](0001-first-record.md)
25+
Supersedes [1. First Record](0001-first-record.md)
2626

2727
## Context
2828

tests/supercede-multiple-adrs.expected

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Date: 1992-01-12
1111

1212
## Status
1313

14-
Superceded by [3. Third Record](0003-third-record.md)
14+
Superseded by [3. Third Record](0003-third-record.md)
1515

1616
head -8 doc/adr/0002-second-record.md
1717
# 2. Second Record
@@ -20,7 +20,7 @@ Date: 1992-01-12
2020

2121
## Status
2222

23-
Superceded by [3. Third Record](0003-third-record.md)
23+
Superseded by [3. Third Record](0003-third-record.md)
2424

2525
head -12 doc/adr/0003-third-record.md
2626
# 3. Third Record
@@ -31,7 +31,7 @@ Date: 1992-01-12
3131

3232
Accepted
3333

34-
Supercedes [1. First Record](0001-first-record.md)
34+
Supersedes [1. First Record](0001-first-record.md)
3535

36-
Supercedes [2. Second Record](0002-second-record.md)
36+
Supersedes [2. Second Record](0002-second-record.md)
3737

0 commit comments

Comments
 (0)