Repository navigation
docs: correct the place fields type annotation - #5
Draft
illuminati1911 wants to merge 1 commit into
Draft
illuminati1911 wants to merge 1 commit into
illuminati1911 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Change
:type input: listto:type fields: listin theplace()docstring so Sphinx attributes the list type to the actualfieldsparameter rather than nonexistentinput.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 -m pytest— 105 passed.python -m pydoc googlemaps.places.placedisplays:type fields: listfrom the installed worktree package.nox --download-python never -s docs --force-python 3.10— passed.Client.placedocumentation in Chromium: the Parameters list displaysfields (list)and has no nonexistentinputparameter.