Skip to content

docs: correct enableUspsCass parameter documentation - #4

Draft
illuminati1911 wants to merge 1 commit into
masterfrom
enable-usps-cass-docstring
Draft

illuminati1911 wants to merge 1 commit into
masterfrom
enable-usps-cass-docstring

Conversation

@illuminati1911

Copy link
Copy Markdown
Collaborator

Summary

  • Attribute the Boolean type to enableUspsCass rather than locality.
  • Add the missing colon after :param enableUspsCass.
  • Separate the parameter fields from the preceding paragraph with a blank line so Sphinx renders them as a Parameters list.

Without the syntax corrections, changing the type field alone would leave the parameter block rendered as plain text. Only the docstring changes; request behavior, signatures, and dependencies are unchanged.

The original malformed parameter block is at: https://github.com/googlemaps/google-maps-services-python/blob/d3b71ab1333cff0f900d2db6b39c1356341a5ea2/googlemaps/addressvalidation.py#L47-L60

Verification

  • Python 3.10: python -m pytest — 105 passed.
  • python -m pydoc googlemaps.addressvalidation displays the corrected fields from the installed worktree package.
  • nox --download-python never -s docs --force-python 3.10 — passed.
  • Visually inspected the generated Client.addressvalidation documentation in Chromium: locality renders as string, enableUspsCass as boolean, and the block is a proper Parameters list rather than raw :param / :type text.
  • 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