Skip to content

Commit 3914d0f

Browse files
authored
Add a note in style_guide.md about using dashes (#3050)
* add admonition explaining the use of dashes over asterisks for bulleted lists
1 parent 701c283 commit 3914d0f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/guides/contribute/style_guide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ If you have a procedure with only one step, use a bullet rather than a number. F
8787

8888
- Implement this idea and move on.
8989

90+
!!! info "A note about bulleted lists"
91+
92+
While markdown rules generally accepts either the asterisk or the dash for bulleted lists (provided they are consistently used throughout the document and are not mixed), to maintain consistency throughout the documentation the recommendation is to use dashes. If your document contains asterisks for bulleted lists, an editor might change those to dashes when checking the content.
93+
9094
### Graphical Interface Language
9195

9296
- Text instructions regarding a UI: When describing the entry of a command into a user interface, use the word “enter” rather than “put” or “type.” Use a codeblock to write out the command (set it off with backticks):

0 commit comments

Comments
 (0)