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

Investigate if T can be imported per file that uses it instead of via utils #480

Closed
abbiemery opened this issue Jul 24, 2024 · 1 comment · Fixed by #700
Closed

Investigate if T can be imported per file that uses it instead of via utils #480

abbiemery opened this issue Jul 24, 2024 · 1 comment · Fixed by #700
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@abbiemery
Copy link
Collaborator

T was moved into utils and imported from there to prevent sphinx from importing it for every single file for the docs. It would be preferable to have T = TypeVar("T") defined in each file that uses it as this is a common use case. We need to investigate with sphinx and see if we can resolve it.

@coretl coretl added this to the 1.0 milestone Jul 26, 2024
@coretl coretl added the documentation Improvements or additions to documentation label Jul 26, 2024
@coretl coretl self-assigned this Dec 9, 2024
@coretl
Copy link
Collaborator

coretl commented Feb 10, 2025

In #700 we now make it a public member of a private module, and use it within that module, then sphinx ignore it. The only exception are public things like SignalDatatypeT which have a non-obvious bound

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants