Skip to content

Commit 983ac31

Browse files
committed
docs: Standardize script names with hyphens in docs
1 parent 10bf5a1 commit 983ac31

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

docs/mit-relates-to.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,27 @@ This is the best readme
3333

3434
If you run
3535

36-
``` shell,script(name="set_relates_to_configuration",expected_exit_code=0)
36+
``` shell,script(name="set-relates-to-configuration",expected_exit_code=0)
3737
git mit-relates-to "[#12321513]"
3838
```
3939

4040
Next time you commit
4141

42-
``` shell,script(name="commit_with_relates_to",expected_exit_code=0)
42+
``` shell,script(name="commit-with-relates-to",expected_exit_code=0)
4343
git add README.md
4444
git mit bt
4545
git commit -m "Wrote a great README"
4646
```
4747

4848
the commit message will contain the ID
4949

50-
``` shell,script(name="show_log_with_relates_to_trailer",expected_exit_code=0)
50+
``` shell,script(name="show-log-with-relates-to-trailer",expected_exit_code=0)
5151
git show --pretty='format:author: [%an %ae] signed-by: [%GS]
5252
---
5353
%B' -q
5454
```
5555

56-
``` text,verify(script_name="show_log_with_relates_to_trailer",stream=stdout)
56+
``` text,verify(script_name="show-log-with-relates-to-trailer",stream=stdout)
5757
author: [Billie Thompson [email protected]] signed-by: []
5858
---
5959
Wrote a great README
@@ -63,7 +63,7 @@ Relates-to: [#12321513]
6363

6464
We don't duplicate the ID if you manually type in the trailer
6565

66-
``` shell,script(name="commit_without_relates_to",expected_exit_code=0)
66+
``` shell,script(name="commit-without-relates-to",expected_exit_code=0)
6767
echo "Some change" >> README.md
6868
git add README.md
6969
git mit bt
@@ -75,13 +75,13 @@ Relates-to: [#12321513]
7575

7676
the commit message will contain the ID
7777

78-
``` shell,script(name="show_log_without_relates_to",expected_exit_code=0)
78+
``` shell,script(name="show-log-without-relates-to",expected_exit_code=0)
7979
git show --pretty='format:author: [%an %ae] signed-by: [%GS]
8080
---
8181
%B' -q
8282
```
8383

84-
``` text,verify(script_name="show_log_without_relates_to",stream=stdout)
84+
``` text,verify(script_name="show-log-without-relates-to",stream=stdout)
8585
author: [Billie Thompson [email protected]] signed-by: []
8686
---
8787
Wrote a great README
@@ -112,13 +112,13 @@ git commit -m "Another great addition"
112112

113113
the commit message will contain the ID
114114

115-
``` shell,script(name="show_log_with_shell_set_trailer",expected_exit_code=0)
115+
``` shell,script(name="show-log-with-shell-set-trailer",expected_exit_code=0)
116116
git show --pretty='format:author: [%an %ae] signed-by: [%GS]
117117
---
118118
%B' -q
119119
```
120120

121-
``` text,verify(script_name="show_log_with_shell_set_trailer",stream=stdout)
121+
``` text,verify(script_name="show-log-with-shell-set-trailer",stream=stdout)
122122
author: [Billie Thompson [email protected]] signed-by: []
123123
---
124124
Another great addition
@@ -160,7 +160,7 @@ command
160160

161161
Next time you commit after running relates to
162162

163-
``` shell,script(name="set_relates_to_template",expected_exit_code=0)
163+
``` shell,script(name="set-relates-to-template",expected_exit_code=0)
164164
git mit-relates-to "12321513"
165165
echo "Something else" >> README.md
166166
git add README.md
@@ -170,13 +170,13 @@ git commit -m "More awesome additions"
170170

171171
the commit message will contain the ID
172172

173-
``` shell,script(name="show_log_with_templated_relates_to",expected_exit_code=0)
173+
``` shell,script(name="show-log-with-templated-relates-to",expected_exit_code=0)
174174
git show --pretty='format:author: [%an %ae] signed-by: [%GS]
175175
---
176176
%B' -q
177177
```
178178

179-
``` text,verify(script_name="set_relates_to_template",stream=stdout)
179+
``` text,verify(script_name="set-relates-to-template",stream=stdout)
180180
author: [Billie Thompson [email protected]] signed-by: []
181181
---
182182
More awesome additions

docs/mit.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -282,13 +282,13 @@ git mit bt ae
282282
git rebase --reset-author-date "-"
283283
```
284284

285-
``` shell,script(name="git-mit-config-mit-non-clean-behaviour-4",expected_exit_code=0)
285+
``` shell,script(name="git-mit-config-mit-non-clean-behaviour",expected_exit_code=0)
286286
git show --pretty='format:author: [%an %ae] signed-by: [%GS]
287287
---
288288
%B' -q
289289
```
290290

291-
``` text,verify(script_name="git-mit-config-mit-non-clean-behaviour-4",stream=stdout)
291+
``` text,verify(script_name="git-mit-config-mit-non-clean-behaviour",stream=stdout)
292292
author: [Billie Thompson [email protected]] signed-by: []
293293
---
294294
Rebase behaviour
@@ -312,14 +312,13 @@ git mit bt ae
312312
git rebase --reset-author-date "-"
313313
```
314314

315-
316-
``` shell,script(name="git-mit-config-mit-non-clean-behaviour-7",expected_exit_code=0)
315+
``` shell,script(name="git-mit-config-mit-non-clean-behaviour-check",expected_exit_code=0)
317316
git show --pretty='format:author: [%an %ae] signed-by: [%GS]
318317
---
319318
%B' -q
320319
```
321320

322-
``` text,verify(script_name="rebase-with-add-to-behavior",stream=stdout)
321+
``` text,verify(script_name="git-mit-config-mit-non-clean-behaviour-check",stream=stdout)
323322
author: [Billie Thompson [email protected]] signed-by: []
324323
---
325324
Rebase behaviour
@@ -334,7 +333,7 @@ The command also works with signed commits
334333

335334
The `bt` user has a valid gpg key.
336335

337-
``` shell,script(name="show_commit_with_multiple_coauthors",expected_exit_code=0)
336+
``` shell,script(name="show-commit-with-multiple-coauthors",expected_exit_code=0)
338337
git mit bt
339338
```
340339

0 commit comments

Comments
 (0)