Skip to content

docs: example code block notes #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 28, 2023
Merged

docs: example code block notes #222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/get-started/docstring-examples.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down