Skip to content

Commit 1652733

Browse files
committed
docs(environments): comment on the name capitalization
Signed-off-by: Jonas Dujava <[email protected]>
1 parent f73950f commit 1652733

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

chapters/Features.tex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ \subsection{Structure Environments}%
259259
There are predefined boxed \enquote{theorem-like} environments for \textsf{Definition}, \textsf{Theorem}, \textsf{Lemma}, \textsf{Corollary}, \textsf{Proposition},
260260
and non-boxed \enquote{remark-like} environments for \textsf{Remark}, \textsf{Proof}, \textsf{Example}, \textsf{Derivation}, \textsf{Calculation}, and \textsf{Tip} (these have at least a mark indicating the end of the environment).
261261

262-
Name of the corresponding environment is lowercase, for example \textsf{definition}, \textsf{remark}, and so on.
262+
Names of the corresponding environments are lowercase, for example \texttt{definition}, \texttt{remark}, and so on.
263263
They also accept an optional argument for a short description.
264264
\end{remark}
265265

@@ -279,6 +279,8 @@ \subsection{Structure Environments}%
279279
\begin{remark}
280280
There are also helper environments for \textsf{Todo}-like notes.
281281
By default, there are \textsf{Todo}, \textsf{Note}, \textsf{Suggestion}, and \textsf{Question} environments, but you can easily create your own.
282+
283+
To avoid conflicts with possible existing macros/environments, names of these environments are capitalized, for example \texttt{Todo}, \texttt{Note}, and so on.
282284
\end{remark}
283285

284286
\begin{Note}

0 commit comments

Comments
 (0)