Skip to content

Commit 7cd62a5

Browse files
author
slimkrazy
committed
Documentation update.
Version bump to 1.3.0
1 parent e920c85 commit 7cd62a5

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

README.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,11 @@ Reference
145145
sensor -- Indicates whether or not the Place request came from a device
146146
using a location sensor (default False)
147147

148-
types -- An optional list of types, restricting the results to Places (default [])
148+
type -- An optional type used for restricting the results to Places (default None)
149+
150+
types -- An optional list of types, restricting the results to Places (default []).
151+
This kwarg has been deprecated in favour of the 'type' kwarg.
152+
149153

150154

151155
text_search(**kwargs)
@@ -164,7 +168,10 @@ Reference
164168
radius -- The radius (in meters) around the location/lat_lng to restrict
165169
the search to. The maximum is 50000 meters (default 3200)
166170

171+
type -- An optional type used for restricting the results to Places (default None)
172+
167173
types -- An optional list of types, restricting the results to Places (default [])
174+
This kwarg has been deprecated in favour of the 'type' kwarg.
168175

169176
autocomplete(**kwargs):
170177
Returns googleplaces.GoogleAutocompleteSearchResult
@@ -218,8 +225,10 @@ Reference
218225
sensor -- Indicates whether or not the Place request came from a
219226
device using a location sensor (default False).
220227

221-
types -- An optional list of types, restricting the results to Places (default [])
228+
type -- An optional type used for restricting the results to Places (default None)
222229

230+
types -- An optional list of types, restricting the results to Places (default [])
231+
This kwarg has been deprecated in favour of the 'type' kwarg.
223232

224233
get_place(**kwargs)
225234
Returns a detailed instance of googleplaces.Place

googleplaces/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
__all__ = ['GooglePlaces', 'GooglePlacesError', 'GooglePlacesAttributeError',
3737
'geocode_location']
38-
__version__ = '1.2.0'
38+
__version__ = '1.3.0'
3939
__author__ = 'Samuel Adu'
4040
__email__ = 'sam@slimkrazy.com'
4141

@@ -246,10 +246,10 @@ def nearby_search(self, language=lang.ENGLISH, keyword=None, location=None,
246246
(imply no radius argument).
247247
sensor -- Indicates whether or not the Place request came from a
248248
device using a location sensor (default False).
249-
type -- Optional type param used to indicate place category
249+
type -- Optional type param used to indicate place category.
250250
types -- An optional list of types, restricting the results to
251251
Places (default []). If there is only one item the request
252-
will be send as type param
252+
will be send as type param.
253253
"""
254254
if location is None and lat_lng is None:
255255
raise ValueError('One of location or lat_lng must be passed in.')
@@ -305,10 +305,10 @@ def text_search(self, query, language=lang.ENGLISH, lat_lng=None,
305305
(default 3200)
306306
query -- The text string on which to search, for example:
307307
"Restaurant in New York".
308-
type -- Optional type param used to indicate place category
308+
type -- Optional type param used to indicate place category.
309309
types -- An optional list of types, restricting the results to
310310
Places (default []). If there is only one item the request
311-
will be send as type param
311+
will be send as type param.
312312
"""
313313
self._request_params = {'query': query}
314314
if lat_lng is not None or location is not None:

0 commit comments

Comments
 (0)