Skip to content

Commit bb33500

Browse files
authored
Merge pull request #222 from machow/docs-numpydoc-quarto
docs: example code block notes
2 parents 98d76e1 + 0aab0e0 commit bb33500

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/get-started/docstring-examples.qmd

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ Below is an example including each.
4848
```
4949
```
5050

51+
Note that different syntaxes are handled differently:
52+
53+
* doctest and markdown syntax: rendered without executing.
54+
* quarto syntax: executed by quarto when you run commands like `quarto render`.
55+
56+
See the quarto documentation on [code blocks](https://quarto.org/docs/computations/python.html#code-blocks) for more detail.
57+
5158

5259
## Examples, etc..: the "s" matters
5360

0 commit comments

Comments
 (0)