Skip to content

Can parameter descriptions support bullet points or line breaks #407

@TommasoGhilardi

Description

@TommasoGhilardi

I hope this isn’t a dumb question...

I’m trying to add bullet points or explicit line breaks inside the description of a parameter in a docstring—but no matter what I do, the rendered .qmd (and then the HTML) squishes everything into a single paragraph. This happens whether parameters are shown as a table or as a definition list.

I’ve tried all the docstring styles (NumPy, Google, reST), played with indentation, blank lines, -, *, you name it—but the output never treats the dashes as a list. They just show up as literal hyphens in a wall of text.

this is an example of a piece i tried using

"""
Parameters
----------
calibration_points : int or list of tuple
    Calibration pattern specification. 
    - Use `5` for the standard 5-point pattern (4 corners + center; default). 
    - Use `9` for a comprehensive 9-point pattern (3×3 grid). 
"""

Is there a way to do it or am i missing something??

Metadata

Metadata

Assignees

No one assigned

    Projects

    Status

    In Progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions