pybricks-api icon indicating copy to clipboard operation
pybricks-api copied to clipboard

Dangling alias of Union[int, float] on signals page

Open laurensvalk opened this issue 3 years ago • 3 comments

The selected alias at the bottom seems to come out of nowhere.

The usual :annotation: does not seem to suppress it.

image

laurensvalk avatar Dec 01 '22 15:12 laurensvalk

It's not a bug, it s feature. :laughing:

Type aliases are a thing in Python, and apparently Sphinx has added special handling for this (this on is implicit rather than explicit).

dlech avatar Dec 01 '22 16:12 dlech

I know, but normally :annotation: suppresses the auto generated annotations. We use it in a few places to suppress excessive info.

laurensvalk avatar Dec 01 '22 16:12 laurensvalk

But since it isn't factually incorrect, I don't mind leaving it in for this release.

We can have a look at it the next time we dig into Sphinx to fix e.g #117

laurensvalk avatar Dec 01 '22 16:12 laurensvalk