search

pybricks / pybricks-api

User API and documentation for Pybricks MicroPython
https://pypi.org/project/pybricks
MIT License
80 stars 23 forks source link

None return type shown even if explicitly hidden on overloaded calls #117

Open laurensvalk opened 1 year ago

laurensvalk commented 1 year ago

Throughout the docs, we do not show ---> None to keep things easy to follow. See https://github.com/pybricks/pybricks-api/issues/99 for rationale.

But on overloaded cases, Sphinx makes them show up on all but the first one.

image

    """
    qstr_info()
    qstr_info(verbose)                       # <---- There's nothing here but still it shows up

    Prints how many strings are interned and how much RAM they use.
laurensvalk commented 1 year ago

This is a styling issue and we don't have many occurrences of this one, so let's not block V3.2 on it.