Skip to content

Commit

Permalink
Update related to example docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
josephmure authored and jschueller committed Jun 17, 2024
1 parent 59cabc9 commit 9b3128b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion developer/doc_development/doc_development.tex
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ \section{Examples}
\item By default, the first image is used as \alert{thumbnail picture}. To use e.g. the third: %$n$\textsuperscript{rd} image:%, write (preferably right above the code that produces the image):

\texttt{\# sphinx\_gallery\_thumbnail\_number = 3} (ideally right above the plot code)
\item In the \alert{script docstring}, \LaTeX{} backslashes \texttt{\textbackslash} need to be doubled: \texttt{\textbackslash\textbackslash}
\item The \alert{script docstring} must be prefixed by the letter \texttt{r}.
\end{itemize}

\end{frame}
Expand Down

0 comments on commit 9b3128b

Please sign in to comment.