Skip to content

readthedocs sphinx doc is not always including * from signatures #6072

@dhalbert

Description

@dhalbert

Asterisks in Sphinx Python type signatures are not showing up in the generated doc, but only sometimes:
usb_cdc.c:

//| def enable(*, console: bool = True, data: bool = False) -> None:
//|     """Enable or disable each CDC device. Can be called in ``boot.py``, before USB is connected.

image

But sometimes it shows up:
SPI.c:

//|     def configure(self, *, baudrate: int = 100000, polarity: int = 0, phase: int = 0, bits: int = 8) -> None:
//|         """Configures the SPI bus. The SPI object must be locked.

image

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions