Skip to content

docs: correct the Time Zone module description - #3

Draft
illuminati1911 wants to merge 1 commit into
masterfrom
timezone-module-description
Draft

illuminati1911 wants to merge 1 commit into
masterfrom
timezone-module-description

Conversation

@illuminati1911

Copy link
Copy Markdown
Collaborator

Summary

Correct the top-level googlemaps.timezone docstring to name the Google Maps Time Zone API instead of the Directions API.

Only one documentation line changes. No request logic, function signatures, or dependencies change.

At the base revision, the module description names Directions although the implementation calls the Time Zone endpoint: https://github.com/googlemaps/google-maps-services-python/blob/d3b71ab1333cff0f900d2db6b39c1356341a5ea2/googlemaps/timezone.py#L18-L54

Verification

  • Python 3.10: python -m pytest — 105 passed.
  • python -m pydoc googlemaps.timezone displays the corrected Time Zone API description from the installed worktree package.
  • nox --download-python never -s docs --force-python 3.10 — passed; generated project documentation visually inspected in Chromium.
  • Built and visually inspected a temporary Sphinx autodoc page for googlemaps.timezone, confirming that the changed module description renders correctly. The normal docs index does not directly include this module description. Temporary source and preview files were removed; no permanent documentation pages or tests were added.
  • The prescribed Python 3.7 docs build remains unverified because Python 3.7 is unavailable on this machine. The Python 3.10 build is supplemental.
  • Pytest ran directly with the repository's test dependencies, avoiding the Nox follow-on Codecov upload.

@illuminati1911 illuminati1911 self-assigned this Oct 15, 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