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

TypeVars in documentation #265

Closed
cjtapper opened this issue Sep 1, 2022 · 1 comment · Fixed by #266
Closed

TypeVars in documentation #265

cjtapper opened this issue Sep 1, 2022 · 1 comment · Fixed by #266

Comments

@cjtapper
Copy link
Contributor

cjtapper commented Sep 1, 2022

Package Version

1.12.2

Description

image

Is there a better way to annotate these types so that the docs are more informative? I'm relatively new to typing and am unsure of what the best way to do this is. Should we just rename _R to something like _HttpResponse?

@adamchainz
Copy link
Owner

Good spot. I know people are disussing ways of improving sphinx's output here, but for now it's pragmatic to use a more explicit typevar name. It will help in text editors that use the hints as well. #266 changes the name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants