Skip to content

Commit 9a27fc9

Browse files
committed
Add substitutions subsection
1 parent b7e3827 commit 9a27fc9

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/dev/style-guide.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ Content
4949
* ``:guilabel:`<your username>` dropdown``
5050
* Make sure that **all bullet list items end with a period**, and don't mix periods with no periods.
5151

52-
5352
Word List
5453
---------
5554

@@ -61,6 +60,14 @@ We have a specific way that we write common words:
6160
* ``open source`` should be lower case, unless you are definitely referring to `OSI's Open Source Definition <https://opensource.org/osd>`.
6261
* ``Git`` should be upper case, except when referring to the command, when it should be written as `:program:\`git\``.
6362

63+
Substitutions
64+
-------------
65+
66+
The following substitutions are used in our documentation to guarantee consistency and make it easy to apply future changes.
67+
68+
* ``|org_brand|`` - used for mentioning of |org_brand|
69+
* ``|com_brand|`` - used for mentioning of |com_brand|
70+
6471
Glossary
6572
--------
6673

0 commit comments

Comments
 (0)