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.

Sign up for GitHub

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

Jump to bottom

Don't show None return type for classes #87

Closed
laurensvalk opened this issue Aug 22, 2021 · 3 comments
Closed

Don't show None return type for classes #87

laurensvalk opened this issue Aug 22, 2021 · 3 comments
Labels
blocked: upstream This issue is with a 3rd-party project and is out of scope of Pybricks

Comments

@laurensvalk
Copy link
Member

laurensvalk commented Aug 22, 2021 •
edited

While an __init__ technically returns none, showing --> None is confusing in signatures like the one below.

It would make more sense to show no return type at all for class initializers.

image

Originally posted by @laurensvalk in #72 (comment)
@laurensvalk
Copy link
Member Author

This appears to happen specifically for docstrings where we manually override the signature.

laurensvalk added a commit to pybricks/sphinx-issues-minimal that referenced this issue Mar 21, 2022
@laurensvalk
bugs: Reproduce None as class return type.
97b0266 
This reproduces pybricks/pybricks-api#87
@laurensvalk laurensvalk mentioned this issue Mar 21, 2022
Closed
@laurensvalk laurensvalk mentioned this issue Mar 28, 2022
Closed
@laurensvalk
Copy link
Member Author

This has been fixed upstream based on the issue we reported in sphinx-doc/sphinx#10280.

@laurensvalk laurensvalk added the blocked: upstream This issue is with a 3rd-party project and is out of scope of Pybricks label Apr 2, 2022
@laurensvalk
Copy link
Member Author

This was fixed upstream, so closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
blocked: upstream This issue is with a 3rd-party project and is out of scope of Pybricks
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@laurensvalk