Skip to content

docs: correct the place fields type annotation - #5

Draft
illuminati1911 wants to merge 1 commit into
masterfrom
place-fields-docstring
Draft

illuminati1911 wants to merge 1 commit into
masterfrom
place-fields-docstring

Conversation

@illuminati1911

Copy link
Copy Markdown
Collaborator

Summary

Change :type input: list to :type fields: list in the place() docstring so Sphinx attributes the list type to the actual fields parameter rather than nonexistent input.

Only one docstring line changes. Request behavior, signatures, and dependencies are unchanged.

The original annotation is at: https://github.com/googlemaps/google-maps-services-python/blob/d3b71ab1333cff0f900d2db6b39c1356341a5ea2/googlemaps/places.py#L428-L451

Verification

  • Python 3.10: python -m pytest — 105 passed.
  • python -m pydoc googlemaps.places.place displays :type fields: list from the installed worktree package.
  • nox --download-python never -s docs --force-python 3.10 — passed.
  • Visually inspected the generated Client.place documentation in Chromium: the Parameters list displays fields (list) and has no nonexistent input parameter.
  • 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