Skip to content

Commit 350551d

Browse files
authored
fix: 🐛 can't use backticks in help docs (#25)
## Description \` can't be used in shell strings, as they tells shell to run a command at that location. Shell strings aren't designed to write Markdown. No review needed. ## Checklist - [x] Ran `just run-all`
1 parent f6baae5 commit 350551d

File tree

2 files changed

+2
-5
lines changed

2 files changed

+2
-5
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,6 @@ Positional arguments:
198198
spaid_gh_set_repo_settings -h
199199
```
200200

201-
/home/luke/.local/bin/spaid_gh_set_repo_settings:3: command not found:
202-
main
203-
204201
Usage: spaid_gh_set_repo_settings \[<org>\] \[<repo>\] \[-h\]
205202

206203
Set up a repository with our Seedcase Project defaults. Settings used
@@ -210,7 +207,7 @@ are:
210207
- Omit the wiki.
211208
- Disable discussions.
212209
- Allow PR’s to have an option to auto-merge after approval.
213-
- Allow PR’s to have an option to easily update with the branch.
210+
- Allow PR’s to have an option to easily update with the ‘main’ branch.
214211
- Allow merge commits as well as rebase and squash merges.
215212

216213
Examples:

bin/spaid_gh_set_repo_settings

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Set up a repository with our Seedcase Project defaults. Settings used are:
99
- Omit the wiki.
1010
- Disable discussions.
1111
- Allow PR's to have an option to auto-merge after approval.
12-
- Allow PR's to have an option to easily update with the `main` branch.
12+
- Allow PR's to have an option to easily update with the 'main' branch.
1313
- Allow merge commits as well as rebase and squash merges.
1414
1515
Examples:

0 commit comments

Comments
 (0)