[DOC] Add note about int eq labels in math directive (#720)

* add note about int eq labels in math directive * update note about int eq labels in math directive * commit suggestion Co-authored-by: Chris Holdgraf <[email protected]> Co-authored-by: Chris Holdgraf <[email protected]>
jupyter-book · Jun 18, 2020 · 485e800 · 485e800
1 parent 0ab1b6d
commit 485e800
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/content/math.md b/docs/content/math.md
@@ -94,6 +94,13 @@ Will generate this:
 w_{t+1} = (1 + r_{t+1}) s(w_t) + y_{t+1}
 ```
 
+
+```{note}
+Labels cannot start with an integer, or they won't be able to be referenced and
+will throw a warning message if referenced. For example, `:label: 1` and `:label: 1eq` cannot
+be referenced.
+```
+
 ### Linking to equations
 
 If you've created an equation with a label, you can link to it from within your text