Skip to content

Commit

Permalink
Improve Nominatim.search docstring (#454)
Browse files Browse the repository at this point in the history
- `view_box` -> `viewbox` plus proper markup
- Specify what `viewbox` actually does
  • Loading branch information
kannes committed Dec 20, 2020
1 parent 866228e commit 52d6e2b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions geopy/geocoders/nominatim.py
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,13 @@ def geocode(
:type viewbox: list or tuple of 2 items of :class:`geopy.point.Point` or
``(latitude, longitude)`` or ``"%(latitude)s, %(longitude)s"``.
:param viewbox: Coordinates to restrict search within.
:param viewbox: Prefer this area to find search results. By default this is
treated as a hint, if you want to restrict results to this area,
specify ``bounded=True`` as well.
Example: ``[Point(22, 180), Point(-22, -180)]``.
:param bool bounded: Restrict the results to only items contained
within the bounding view_box.
within the bounding ``viewbox``.
:param str featuretype: If present, restrict results to certain type of features.
Allowed values: `country`, `state`, `city`, `settlement`.
Expand Down

0 comments on commit 52d6e2b

Please sign in to comment.