googlemaps / google-maps-services-python

Python client library for Google Maps API Web Services
Apache License 2.0
4.5k stars 1.3k forks source link

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

Open henri-chat-noir opened 3 years ago

henri-chat-noir commented 3 years ago

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.

stale[bot] commented 3 years ago

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[bot] commented 2 years ago

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

wangela commented 1 year ago

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.

stale[bot] commented 1 year ago

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!

connorjoleary commented 10 months ago

Still valid!