diff options
| author | Jim Newsome <jnewsome@torproject.org> | 2023-11-09 11:11:47 -0600 |
|---|---|---|
| committer | Jim Newsome <jnewsome@torproject.org> | 2023-11-09 18:45:20 -0600 |
| commit | 16b82bed5a8b1f520bad8e3aa69e25e69809d1fe (patch) | |
| tree | 32319e353aff8c548476cef8f2df9268e3ffc8db | |
| parent | 865a95d684f22f05a0b28f5268b32ce27f17eb54 (diff) | |
| download | torspec-16b82bed5a8b1f520bad8e3aa69e25e69809d1fe.tar.gz torspec-16b82bed5a8b1f520bad8e3aa69e25e69809d1fe.zip | |
Remove unnecessary brackets
| -rw-r--r-- | spec/STYLE.md | 2 | ||||
| -rw-r--r-- | spec/back-matter.md | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/spec/STYLE.md b/spec/STYLE.md index 102b786..74388c3 100644 --- a/spec/STYLE.md +++ b/spec/STYLE.md @@ -133,7 +133,7 @@ for more information about how.) If you want to link to a specific section within a file, make sure that the section has a defined anchor that makes sense. -The syntax to define [heading ids] in mdbook looks like this: +The syntax to define heading ids in mdbook looks like this: `## Heading with a long title that you want shorter name for { #shortname }` diff --git a/spec/back-matter.md b/spec/back-matter.md index a0dc862..90ddea2 100644 --- a/spec/back-matter.md +++ b/spec/back-matter.md @@ -58,11 +58,11 @@ see the To edit these specs, clone the [git repository](https://gitlab.torproject.org/tpo/core/torspec/) and edit the -appropriate file in the [`spec` directory]. These files will match +appropriate file in the `spec` directory. These files will match the URLs of their corresponding pages, so if you want to edit -[`tor-spec/flow-control.html`], +`tor-spec/flow-control.html`, you'll be looking for a file -called [`spec/tor-spec/flow-control.md`]. +called `spec/tor-spec/flow-control.md`. We have started a [style guide](./STYLE.md) for writing new parts of this spec; as of 2023 it is quite preliminary. You should feel free to |