Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
laurensvalk opened this issue Dec 1, 2022 · 3 comments
Open

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

laurensvalk opened this issue Dec 1, 2022 · 3 comments

Comments

@laurensvalk
Copy link
Member

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

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

image

@dlech
Copy link
Member

dlech commented Dec 1, 2022

It's not a bug, it s feature. 😆

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

@laurensvalk
Copy link
Member Author

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

@laurensvalk
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants