[go: nahoru, domu]

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

Make documentation linkage between api names easier to find/see #394

Open
henri-chat-noir opened this issue Feb 3, 2021 · 5 comments
Open
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@henri-chat-noir
Copy link

First off, really effective wrapper and complete on all the Google APIs. No complaints from my usage so far.

This is very trivial, but for complete newbies like me, might be helpful. Remembering that Google has a lot to say about it's APIs that might not be captured in this documentation (and shouldn't be), e.g. if you include a region code in a Places request, the country name is excluded from formatted address. So . . .

Perhaps in documentation and/or code base doc strings, add reference to Google names for API? For instance, took me a long time to work through that "places" is the same as "textsearch" because "textsearch" doesn't appear in the code. A formatted print string separates "text" and "search", so references on repo pretty sparse.

Small idea. No big deal of course, but thought I'd try to contribute something back.

@henri-chat-noir henri-chat-noir added triage me I really want to be triaged. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Feb 3, 2021
@stale
Copy link
stale bot commented Jun 3, 2021

This issue has been automatically marked as stale because it has not had recent activity. Please comment here if it is still valid so that we can reprioritize. Thank you!

@stale stale bot added the stale label Jun 3, 2021
@stale
Copy link
stale bot commented Apr 16, 2022

Closing this. Please reopen if you believe it should be addressed. Thank you for your contribution.

@stale stale bot closed this as completed Apr 16, 2022
@wangela wangela added type: docs Improvement to the documentation for an API. and removed type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. triage me I really want to be triaged. stale labels Jan 27, 2023
@wangela
Copy link
Member
wangela commented Jan 27, 2023

Reopening as valid. We could edit the description of each subclass of Client (e.g. Client.directions()) to include a link to the corresponding documentation on developers.google.com (e.g. Directions API documentation). For directions, the description is defined toward the beginning of directions.py.

@wangela wangela reopened this Jan 27, 2023
@wangela wangela added the priority: p3 Desirable enhancement or fix. May not be included in next release. label Jan 27, 2023
@stale
Copy link
stale bot commented Jun 18, 2023

This issue has been automatically marked as stale because it has not had recent activity. Please comment here if it is still valid so that we can reprioritize. Thank you!

@stale stale bot added the stale label Jun 18, 2023
@connorjoleary
Copy link

Still valid!

@stale stale bot removed the stale label Nov 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

5 participants