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

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

Open
laurensvalk opened this issue Nov 29, 2022 · 1 comment
Open

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

laurensvalk opened this issue Nov 29, 2022 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@laurensvalk
Copy link
Member

Throughout the docs, we do not show ---> None to keep things easy to follow. See #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 laurensvalk added bug Something isn't working documentation Improvements or additions to documentation labels Nov 29, 2022
@laurensvalk
Copy link
Member Author

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

laurensvalk added a commit that referenced this issue Dec 1, 2022
@laurensvalk
pybricks.hubs: Update storage documentation.
d4d7971 
This moves the per-hub storage size to the respective page.

This also clarifies that data is cleared when updating Powered Up hubs.

Also flip docstring signatures around to work around #117
@laurensvalk laurensvalk mentioned this issue Dec 1, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@laurensvalk