Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Places: region parameter no longer needed in Nearby Search #404

Closed
NicoSerranoP opened this issue Apr 24, 2021 · 2 comments
Closed

Places: region parameter no longer needed in Nearby Search #404

NicoSerranoP opened this issue Apr 24, 2021 · 2 comments
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. stale type: docs Improvement to the documentation for an API.

Comments

@NicoSerranoP
Copy link

The library documentation specifies that a region parameter can be passed in the places_nearby method (check it out here).

Looking at the code, you can see that places_nearby never uses the region parameter but it is specified in the comments section (check it out in line 270).

I notice this problem because I was blindly following the documentation trying to invoke the places_nearby method. If you input a specific region (ex: region="EC"), python throws a problem:

TypeError: places_nearby() got an unexpected keyword argument 'region'

I think the only problem is the region part in the comment section that is making it appear in the documentation and misleading newbie programmers like me to get an unexpected type error. I suggest just deleting that line and recompiling the documentation. I could submit a pull request but I was wondering if my idea is correct or if I need extra permission to do so.

Steps to reproduce

  1. Try to use the googlemaps.Client.places_nearby method by inputting a specific region.

Code example

result = gmaps_client.places_nearby(
    location = (-33.86746, 151.207090),
    radius = 100, # in meters
    region = "EC", 
    keyword = "something related to the business",
    language = "es-419",
    type = "liquor_store", 
    page_token = None
)

Best wishes,

Nico

@NicoSerranoP NicoSerranoP added triage me I really want to be triaged. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Apr 24, 2021
@wangela wangela added type: docs Improvement to the documentation for an API. and removed type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Jan 27, 2023
@wangela wangela added priority: p3 Desirable enhancement or fix. May not be included in next release. and removed triage me I really want to be triaged. labels Jan 27, 2023
@stale
Copy link

stale bot commented Jun 18, 2023

This issue has been automatically marked as stale because it has not had recent activity. Please comment here if it is still valid so that we can reprioritize. Thank you!

@stale stale bot added the stale label Jun 18, 2023
@NicoSerranoP
Copy link
Author

The docs were updated, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. stale type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

3 participants