Docstrings cleaning

Author: Martin Journois

folium/colormap.py

@@ -432,8 +432,8 @@ def to_step(self, n=None, index=None, data=None, method=None,
               order-of-magnitude integer. For example, 2100 is rounded to
               2000, 2790 to 3000.
 
-        Return
-        ------
+        Returns
+        -------
         A StepColormap with `n=len(index)-1` colors.
 
         Examples:

folium/element.py

@@ -146,11 +146,7 @@ def save(self, outfile, close_file=True, **kwargs):
 
 
 class Link(Element):
-    """Link
-    ----
-
-    TODO: docstring.
-    """
+    """TODO: docstring."""
     def get_code(self):
         """TODO : docstring."""
         if self.code is None:

folium/folium.py

@@ -168,8 +168,8 @@ def simple_marker(self, location=None, popup=None,
         -------
         Marker names and HTML in obj.template_vars
 
-        Example
-        -------
+        Examples
+        --------
         >>> map.simple_marker(location=[45.5, -122.3], popup='Portland, OR')
         >>> map.simple_marker(location=[45.5, -122.3], popup=(vis, 'vis.json'))
 
@@ -224,8 +224,8 @@ def line(self, locations,
         Note: If the optional styles are omitted, they will not be included
         in the HTML output and will obtain the Leaflet defaults listed above.
 
-        Example
-        -------
+        Examples
+        --------
         >>> map.line(locations=[(45.5, -122.3), (42.3, -71.0)])
         >>> map.line(locations=[(45.5, -122.3), (42.3, -71.0)],
                      line_color='red', line_opacity=1.0)
@@ -274,8 +274,8 @@ def multiline(self, locations, line_color=None, line_opacity=None,
         Note: If the optional styles are omitted, they will not be included
         in the HTML output and will obtain the Leaflet defaults listed above.
 
-        Example
-        -------
+        Examples
+        --------
         # FIXME: Add another example.
         >>> m.multiline(locations=[[(45.5236, -122.675), (45.5236, -122.675)],
                                    [(45.5237, -122.675), (45.5237, -122.675)],
@@ -328,8 +328,8 @@ def circle_marker(self, location=None, radius=500, popup=None,
         -------
         Circle names and HTML in obj.template_vars
 
-        Example
-        -------
+        Examples
+        --------
         >>> map.circle_marker(location=[45.5, -122.3],
                               radius=1000, popup='Portland, OR')
         >>> map.circle_marker(location=[45.5, -122.3],
@@ -433,8 +433,8 @@ def click_for_marker(self, popup=None):
         popup:
             Custom popup text
 
-        Example
-        -------
+        Examples
+        --------
         >>> map.click_for_marker(popup='Your Custom Text')
 
         """
@@ -464,8 +464,8 @@ def fit_bounds(self, bounds, padding_top_left=None,
         max_zoom: int, default None
             Maximum zoom to be used.
 
-        Example
-        -------
+        Examples
+        --------
         >>> map.fit_bounds([[52.193636, -2.221575], [52.636878, -1.139759]])
 
         """
@@ -572,12 +572,12 @@ def choropleth(self, geo_path=None, geo_str=None, data_out='data.json',
         reset: boolean, default False
             Remove all current geoJSON layers, start with new layer
 
-        Output
-        ------
+        Returns
+        -------
         GeoJSON data layer in obj.template_vars
 
-        Example
-        -------
+        Examples
+        --------
         >>> m.choropleth(geo_path='us-states.json', line_color='blue',
                          line_weight=3)
         >>> m.choropleth(geo_path='geo.json', data=df,
@@ -729,12 +729,13 @@ def image_overlay(self, data, opacity=0.25, min_lat=-90.0, max_lat=90.0,
         mercator_project : bool, default False, used only for array-like image.
             Transforms the data to project (longitude,latitude) coordinates
             to the Mercator projection.
-        Output
-        ------
+
+        Returns
+        -------
         Image overlay data layer in obj.template_vars
 
         Examples
-        -------
+        --------
         # assumes a map object `m` has been created
         >>> import numpy as np
         >>> data = np.random.random((100,100))

folium/map.py

@@ -444,8 +444,8 @@ class Marker(MacroElement):
     -------
     Marker names and HTML in obj.template_vars
 
-    Example
-    -------
+    Examples
+    --------
     >>> Marker(location=[45.5, -122.3], popup='Portland, OR')
     >>> Marker(location=[45.5, -122.3], popup=folium.Popup('Portland, OR'))
     """

folium/utilities.py

@@ -60,8 +60,9 @@ def linear_gradient(hexList, nColors):
     nColors where the colors are linearly interpolated between the
     (r, g, b) tuples that are given.
 
-    Example:
-    linear_gradient([(0, 0, 0), (255, 0, 0), (255, 255, 0)], 100)
+    Examples
+    --------
+    >>> linear_gradient([(0, 0, 0), (255, 0, 0), (255, 255, 0)], 100)
 
     """
     def _scale(start, finish, length, i):