From 0aab0e0c3d8b3528ae22a9f213048aec8944951d Mon Sep 17 00:00:00 2001 From: Michael Chow Date: Mon, 24 Jul 2023 14:45:55 -0400 Subject: [PATCH] docs: example code block notes --- docs/get-started/docstring-examples.qmd | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/get-started/docstring-examples.qmd b/docs/get-started/docstring-examples.qmd index addd1729..4a1d1b67 100644 --- a/docs/get-started/docstring-examples.qmd +++ b/docs/get-started/docstring-examples.qmd @@ -48,6 +48,13 @@ Below is an example including each. ``` ``` +Note that different syntaxes are handled differently: + +* doctest and markdown syntax: rendered without executing. +* quarto syntax: executed by quarto when you run commands like `quarto render`. + +See the quarto documentation on [code blocks](https://quarto.org/docs/computations/python.html#code-blocks) for more detail. + ## Examples, etc..: the "s" matters