Skip to content
This repository has been archived by the owner on Sep 8, 2023. It is now read-only.

Commit

Permalink
Update docs-style.md (#271)
Browse files Browse the repository at this point in the history
* Update docs-style.md

Correct an error in escaping angle brackets.

* Update docs-style.md

Correcting my corrections.
  • Loading branch information
floriographygoth authored Aug 26, 2020
1 parent 56c19aa commit 533a294
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion basics/docs-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Where possible, avoid terms that orient things in time, such as referencing
specific dates (Q2 2020) or saying "now", "currently", or "soon." These go
stale quickly and could be incorrect if it's a future projection. Instead,
specify a version level instead, such as "Bazel X.x and higher supports
<feature>" or a GitHub issue link.
\<feature\>" or a GitHub issue link.

- **YES:** Bazel 0.10.0 or later supports remote caching.
- **NO:** Bazel will soon support remote caching, likely in October 2017.
Expand Down Expand Up @@ -170,6 +170,7 @@ for recommended Markdown style.
### Placeholders

- Use angle brackets to denote a variable that users should change.
In Markdown, escape the angle brackets with a back slash: `\<example\>`.
- **YES:** `bazel help <command>`: Prints help and options for `<command>`
- **NO:** bazel help _command_: Prints help and options for "command"

Expand Down

0 comments on commit 533a294

Please sign in to comment.