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

Unexpected "alias of" note in docs. #69

Closed
laurensvalk opened this issue Jul 14, 2021 · 4 comments
Closed

Unexpected "alias of" note in docs. #69

laurensvalk opened this issue Jul 14, 2021 · 4 comments

Comments

@laurensvalk
Copy link
Member

image

The "alias of" part seems unintended (although we'll still want to mention int and float in the actual docstring.)

Might be fixed in newer Sphinx version: sphinx-doc/sphinx#9218
@laurensvalk
Copy link
Member Author

We can't currently update because our conf.py imports PyClassmember which has been deprecated.

@laurensvalk
Copy link
Member Author

This still happens in Sphinx 4.1, so probably not worth upgrading just for that, due to #70 .

image

@laurensvalk
Copy link
Member Author

We can't currently update because our conf.py imports PyClassmember which has been deprecated.

Just deleting it makes it pass and there don't seem to be side effects for lights and buttons, which appears to be why we had this customization.

@laurensvalk
Copy link
Member Author

The TConst no longer appears in the docs so this is no longer an issue.

laurensvalk added a commit that referenced this issue Jul 23, 2021
@laurensvalk
doc/common/conf: Drop EV3 hack.
8d521c1 
This is no longer required, perhaps not even for EV3. For example, PrimeHub.speaker looks as intended.

We want to reduce the number of hacks because they tend to break updates (#69 (comment)).
laurensvalk added a commit that referenced this issue Jul 23, 2021
@laurensvalk
doc/common/conf: Drop class method hack.
e4c7e5a 
This can be traced back to 0013a74 and 92e3735.

It was used to work around things like

sound.beeps(number)
   Description

being incorrectly displayed as

classmethod sound.beeps(number)
   Description

But the current version of sphinx appears to display this correctly even without the hack. We want to reduce the number of hacks because they tend to break updates (#69 (comment)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@laurensvalk