Notes

Contents


Example note

Define special doc-note blocks in docstrings and they will be rendered here. Markdown is supported.

You can even do diagrams with mermaid:

graph LR a --> b a --> c b --> c

Was produced from:

::: doc-note Example note
    Define special `doc-note` blocks in docstrings and they will be rendered here.
    Markdown is supported.

    You can even do diagrams with [mermaid](https://mermaid-js.github.io/mermaid/#/):
    ```mermaid
    graph LR
        a --> b
        a --> c
        b --> c
    ```