Skip to content

docs: update Places docstrings with Legacy links - #10

Draft
illuminati1911 wants to merge 1 commit into
masterfrom
places-documentation-links
Draft

illuminati1911 wants to merge 1 commit into
masterfrom
places-documentation-links

Conversation

@illuminati1911

Copy link
Copy Markdown
Collaborator

Summary

  • Replace eight obsolete link occurrences across the Find Place, Text Search, Nearby Search, Place Details, and Place Autocomplete docstrings with canonical Places API (Legacy) references and relevant parameter sections.
  • Identify these methods as Legacy and link Google's official migration overview without pointing existing parameters at incompatible Places API (New) request formats.
  • Change docstrings only; executable code, method signatures, tests, and the changelog are unchanged.

The existing Find Place references point to the old search URL and its obsolete fragment: https://github.com/googlemaps/google-maps-services-python/blob/d3b71ab1333cff0f900d2db6b39c1356341a5ea2/googlemaps/places.py#L143-L150

Place Details also links an old product-changes page instead of a field reference: https://github.com/googlemaps/google-maps-services-python/blob/d3b71ab1333cff0f900d2db6b39c1356341a5ea2/googlemaps/places.py#L448-L451

Migration guidance: https://developers.google.com/maps/documentation/places/web-service/legacy/migrate-overview

Verification

On Python 3.10.20:

  • python -m pytest tests/test_places.py — 7 passed.
  • python -m pytest — 105 passed.
  • nox --download-python never -s docs --force-python 3.10 — repository Sphinx build passed.
  • Verified HTTP responses, canonical URLs, and section anchors for all eight distinct documentation/migration targets.
  • Visually inspected all five affected public methods in the generated repository documentation.
  • AST comparison confirmed executable code is unchanged. Diff/whitespace checks passed.

The prescribed Python 3.7 docs build remains unverified because that interpreter is unavailable. The Python 3.10 build is supplemental. Tests ran directly using the repository's test dependencies, avoiding the automatic Codecov upload. Only documentation URLs were requested; no Maps API calls or credentials were used.

@illuminati1911 illuminati1911 self-assigned this Oct 19, 2026
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 this pull request may close these issues.

1 participant