Docs: clarify the `geocoder.geocode(..., timeout=None)` scenario
@@ -147,6 +147,17 @@ class options(object):
before raising a :class:`geopy.exc.GeocoderTimedOut` exception.
Pass `None` to disable timeout.
+ .. note::
+ Currently ``None`` as a value is processed correctly only
+ for the ``geopy.geocoders.options.default_timeout`` option
+ value. ``timeout=None`` as a method argument (i.e.
+ ``geocoder.geocode(..., timeout=None)``) would be treated
+ as "use timeout, as set in
+ ``geopy.geocoders.options.default_timeout``", and
+ a deprecation warning would be raised.
+ In geopy 2.0 this will change, so that ``timeout=None``
+ would actually disable timeout.
+
default_user_agent
User-Agent header to send with the requests to geocoder API.
"""
