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

Add Documentation for google-api-python-client-stubs or Provide Built-in Type Annotations #2538

Open
Demianeen opened this issue Dec 19, 2024 · 0 comments
Assignees

Comments

@Demianeen
Copy link

While resolving #2537, I discovered that the root cause of my confusion was a lack of type safety for build function. I initially passed credentials as a positional argument instead of using the credentials= keyword, which could have been caught immediately if the method signature and documentation were more explicit.

What I mean, this is how types look for build function:
Arc 2024-12-19 07 27 57

I found that python has stubs feature, similar to @types packages in npm, but there was no mention of it in google docs. Which bings me to this issue.

It would be ideal to provide built-in type annotation. But as a workaround it would be really beneficial to add mention of google-api-python-client-stubs in the docs. It will help new python users like myself help avoid such simple and time-consuming mistakes.

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

No branches or pull requests

2 participants