Added note about replacement order

ofloveandhate · Jul 16, 2024 · eda9608 · eda9608
1 parent 268ce4b
commit eda9608
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/tutorials/text_replacements.rst b/docs/tutorials/text_replacements.rst
@@ -25,6 +25,8 @@ Note that `_course_metadata/replacements.json` is just a regular old JSON file.
 Usage
 --------
 
+Keep in mind that the order of replacement is unspecified. Thus, it is important to choose keys that will not appear within values, and will not appear within source documents where replacement is undesired.
+
 
 Custom text replacements per-content
 --------------------------------------