Skip to content

Doc suggestion: show output, and include code block examples that don't evaluate code #219

@wch

Description

@wch

The code block example using Quarto-style code blocks, ```{python}, evaluates the code. It would be good to show an example that does not evaluate the code.

These are the examples. It's not clear what the output of each one looks like.

    Examples
    --------
    
    doctest syntax:
    
    >>> 1 + 1
    2
    
    markdown syntax:
    
    ```python
    1 + 1
    ```
    
    quarto syntax:
    
    ```{python}
    1 + 1
    ```

For example, does it output the following for all -- or just for the doctest and quarto syntax?

>>> 1 + 1
2

In any case, it would be good to include an example of how to use quarto syntax and not evaluate the code, like this:

    ```{python}
    #| eval: false
    1 + 1
    ```

Metadata

Metadata

Assignees

No one assigned

    Labels

    time:shortTakes an hour or less to resolvetype:documentationImprovements or additions to documentation

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions