Skip to content

Commit d2ff3ec

Browse files
author
Chris Cho
committed
substitutions example
1 parent 53ffe4c commit d2ff3ec

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

source/style-guide/markup/format/substitutions.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ source constants. When used consistently, they help prevent inconsistencies in
88
formatting the term and make it easy to change the value for all its
99
occurrences.
1010

11+
For example, you can use a substitution to represent the name of a MongoDB
12+
product, like Compass. with a variable, descriptively named ``gui-tool``.
13+
If the product name changes, you only need to update the value of the
14+
variable ``gui-tool`` to update all the instances of "Compass" in the
15+
documentation site.
16+
1117
Source Constants
1218
----------------
1319

0 commit comments

Comments
 (0)