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

Autoaliasattr: TypeVar #3752

Open
JasonGrace2282 opened this issue May 7, 2024 · 0 comments
Open

Autoaliasattr: TypeVar #3752

JasonGrace2282 opened this issue May 7, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation typehints For adding/discussing typehints
Milestone

Comments

@JasonGrace2282
Copy link
Contributor

JasonGrace2282 commented May 7, 2024

Manim's autoaliasattr directive does not document TypeVars.
Especially as the amount of type hints in manim increase, this can make it confusing to read the type hint when occasions such as list[H] occur, when earlier in the code H was defined as TypeVar("H", bound=Hashable] and it was simply not documented.

Potentially, they could be a different section since they typically don't have a description associated with them, and, as such, several typevars can just be in one code block.

@JasonGrace2282 JasonGrace2282 added documentation Improvements or additions to documentation typehints For adding/discussing typehints labels May 7, 2024
@JasonGrace2282 JasonGrace2282 added this to the v0.19.0 milestone May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation typehints For adding/discussing typehints
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants