Docstring cleanig, again

Author: Martin Journois

folium/colormap.py

@@ -4,8 +4,8 @@
 -------
 
 Utility module for dealing with colormaps.
-
 """
+
 from __future__ import absolute_import
 
 import math
@@ -264,8 +264,7 @@ class ColorMap(MacroElement):
 
     Parameters
     ----------
-    TODO: docstring
-    """
+    TODO: docstring"""
 
     def __init__(self, vmin=0., vmax=1., caption=""):
         super(ColorMap, self).__init__()
@@ -349,13 +348,14 @@ class LinearColormap(ColorMap):
 
     Parameters
     ----------
+
     colors : list-like object
         The set of colors to be used for interpolation.
         Colors can be provided in the form:
         * tuples of int between 0 and 255 (e.g: `(255,255,0)` or
-          `(255, 255, 0, 255)`)
+        `(255, 255, 0, 255)`)
         * tuples of floats between 0. and 1. (e.g: `(1.,1.,0.)` or
-          `(1., 1., 0., 1.)`)
+        `(1., 1., 0., 1.)`)
         * HTML-like string (e.g: `"#ffff00`)
         * a color name or shortcut (e.g: `"y"` or `"yellow"`)
     index : list of floats, default None
@@ -367,8 +367,8 @@ class LinearColormap(ColorMap):
         Values lower than `vmin` will be bound directly to `colors[0]`.
     vmax : float, default 1.
         The maximal value for the colormap.
-        Values higher than `vmax` will be bound directly to `colors[-1]`.
-    """
+        Values higher than `vmax` will be bound directly to `colors[-1]`."""
+
     def __init__(self, colors, index=None, vmin=0., vmax=1., caption=""):
         super(LinearColormap, self).__init__(vmin=vmin, vmax=vmax,
                                              caption=caption)
@@ -404,8 +404,7 @@ def rgba_floats_tuple(self, x):
 
     def to_step(self, n=None, index=None, data=None, method=None,
                 quantiles=None, round_method=None):
-        """
-        Splits the LinearColormap into a StepColormap.
+        """Splits the LinearColormap into a StepColormap.
 
         Parameters
         ----------
@@ -429,8 +428,8 @@ def to_step(self, n=None, index=None, data=None, method=None,
             The method used to round thresholds.
             * If 'int', all values will be rounded to the nearest integer.
             * If 'log10', all values will be rounded to the nearest
-              order-of-magnitude integer. For example, 2100 is rounded to
-              2000, 2790 to 3000.
+            order-of-magnitude integer. For example, 2100 is rounded to
+            2000, 2790 to 3000.
 
         Returns
         -------
@@ -534,9 +533,9 @@ class StepColormap(ColorMap):
         The set of colors to be used for interpolation.
         Colors can be provided in the form:
         * tuples of int between 0 and 255 (e.g: `(255,255,0)` or
-          `(255, 255, 0, 255)`)
+        `(255, 255, 0, 255)`)
         * tuples of floats between 0. and 1. (e.g: `(1.,1.,0.)` or
-          `(1., 1., 0., 1.)`)
+        `(1., 1., 0., 1.)`)
         * HTML-like string (e.g: `"#ffff00`)
         * a color name or shortcut (e.g: `"y"` or `"yellow"`)
     index : list of floats, default None

folium/element.py

@@ -583,20 +583,23 @@ def render(self, **kwargs):
 class MacroElement(Element):
     """This is a parent class for Elements defined by a macro template.
     To compute your own element, all you have to do is:
-        * To inherit from this class
-        * Overwrite the '_name' attribute
-        * Overwrite the '_template' attribute with something of the form:
-            {% macro header(this, kwargs) %}
-                ...
-            {% endmacro %}
-
-            {% macro html(this, kwargs) %}
-                ...
-            {% endmacro %}
-
-            {% macro script(this, kwargs) %}
-                ...
-            {% endmacro %}
+
+    * To inherit from this class
+    * Overwrite the '_name' attribute
+    * Overwrite the '_template' attribute with something of the form::
+
+        {% macro header(this, kwargs) %}
+            ...
+        {% endmacro %}
+
+        {% macro html(this, kwargs) %}
+            ...
+        {% endmacro %}
+
+        {% macro script(this, kwargs) %}
+            ...
+        {% endmacro %}
+
     """
     def __init__(self):
         super(MacroElement, self).__init__()

folium/features.py

@@ -248,9 +248,9 @@ class GeoJson(Layer):
     data: file, dict or str.
         The GeoJSON data you want to plot.
         * If file, then data will be read in the file and fully
-          embedded in Leaflet's JavaScript.
+        embedded in Leaflet's JavaScript.
         * If dict, then data will be converted to JSON and embedded
-          in the JavaScript.
+        in the JavaScript.
         * If str, then data will be passed to the JavaScript as-is.
     style_function: function, default None
         A function mapping a GeoJson Feature to a style dict.
@@ -372,9 +372,9 @@ class TopoJson(Layer):
     data: file, dict or str.
         The TopoJSON data you want to plot.
         * If file, then data will be read in the file and fully
-          embedded in Leaflet's JavaScript.
+        embedded in Leaflet's JavaScript.
         * If dict, then data will be converted to JSON and embedded
-          in the JavaScript.
+        in the JavaScript.
         * If str, then data will be passed to the JavaScript as-is.
     object_path: str
         The path of the desired object into the TopoJson structure.
@@ -832,9 +832,9 @@ class CustomIcon(Icon):
         The data you want to use as an icon.
         * If string, it will be written directly in the output file.
         * If file, it's content will be converted as embedded in the
-          output file.
+        output file.
         * If array-like, it will be converted to PNG base64 string
-          and embedded in the output.
+        and embedded in the output.
     icon_size : tuple of 2 int
         Size of the icon image in pixels.
     icon_anchor : tuple of 2 int

folium/folium.py

@@ -36,6 +36,7 @@ class Map(LegacyMap):
     Generate a base map of given width and height with either default
     tilesets or a custom tileset URL. The following tilesets are built-in
     to Folium. Pass any of the following to the "tiles" keyword:
+
         - "OpenStreetMap"
         - "MapQuest Open"
         - "MapQuest Open Aerial"
@@ -45,6 +46,7 @@ class Map(LegacyMap):
         - "Cloudmade" (Must pass API key)
         - "Mapbox" (Must pass API key)
         - "CartoDB" (positron and dark_matter)
+
     You can pass a custom tileset to Folium by passing a Leaflet-style
     URL to the tiles parameter:
     http://{s}.yourtiles.com/{z}/{x}/{y}.png
@@ -77,15 +79,15 @@ class Map(LegacyMap):
         into pixel (screen) coordinates and back.
         You can use Leaflet's values :
         * EPSG3857 : The most common CRS for online maps, used by almost all
-          free and commercial tile providers. Uses Spherical Mercator projection.
-          Set in by default in Map's crs option.
+        free and commercial tile providers. Uses Spherical Mercator projection.
+        Set in by default in Map's crs option.
         * EPSG4326 : A common CRS among GIS enthusiasts. Uses simple Equirectangular
-          projection.
+        projection.
         * EPSG3395 : Rarely used by some commercial tile providers. Uses Elliptical
-          Mercator projection.
+        Mercator projection.
         * Simple : A simple CRS that maps longitude and latitude into x and y directly.
-          May be used for maps of flat surfaces (e.g. game maps). Note that the y axis
-          should still be inverted (going from bottom to top).
+        May be used for maps of flat surfaces (e.g. game maps). Note that the y axis
+        should still be inverted (going from bottom to top).
 
     Returns
     -------
@@ -106,8 +108,8 @@ class Map(LegacyMap):
     def create_map(self, path='map.html', plugin_data_out=True, template=None):
         """Write Map output to HTML.
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         path: string, default 'map.html'
             Path for HTML output for map
         plugin_data_out: boolean, default True
@@ -276,15 +278,15 @@ def multiline(self, locations, line_color=None, line_opacity=None,
 
         Examples
         --------
-        # FIXME: Add another example.
         >>> m.multiline(locations=[[(45.5236, -122.675), (45.5236, -122.675)],
                                    [(45.5237, -122.675), (45.5237, -122.675)],
                                    [(45.5238, -122.675), (45.5238, -122.675)]])
         >>> m.multiline(locations=[[(45.5236, -122.675), (45.5236, -122.675)],
                                    [(45.5237, -122.675), (45.5237, -122.675)],
                                    [(45.5238, -122.675), (45.5238, -122.675)]],
-                                   line_color='red', line_weight=2,
-                                   line_opacity=1.0)
+                        line_color='red', line_weight=2,
+                        line_opacity=1.0)
+        FIXME: Add another example.
         """
         warnings.warn("%s is deprecated. Use %s instead" %
                       ("multiline", "add_children(MultiPolyLine)"),

folium/map.py

@@ -26,6 +26,7 @@ class LegacyMap(MacroElement):
     Generate a base map of given width and height with either default
     tilesets or a custom tileset URL. The following tilesets are built-in
     to Folium. Pass any of the following to the "tiles" keyword:
+
         - "OpenStreetMap"
         - "MapQuest Open"
         - "MapQuest Open Aerial"
@@ -35,6 +36,7 @@ class LegacyMap(MacroElement):
         - "Cloudmade" (Must pass API key)
         - "Mapbox" (Must pass API key)
         - "CartoDB" (positron and dark_matter)
+
     You can pass a custom tileset to Folium by passing a Leaflet-style
     URL to the tiles parameter:
     http://{s}.yourtiles.com/{z}/{x}/{y}.png
@@ -67,15 +69,15 @@ class LegacyMap(MacroElement):
         into pixel (screen) coordinates and back.
         You can use Leaflet's values :
         * EPSG3857 : The most common CRS for online maps, used by almost all
-          free and commercial tile providers. Uses Spherical Mercator projection.
-          Set in by default in Map's crs option.
+        free and commercial tile providers. Uses Spherical Mercator projection.
+        Set in by default in Map's crs option.
         * EPSG4326 : A common CRS among GIS enthusiasts. Uses simple Equirectangular
-          projection.
+        projection.
         * EPSG3395 : Rarely used by some commercial tile providers. Uses Elliptical
-          Mercator projection.
+        Mercator projection.
         * Simple : A simple CRS that maps longitude and latitude into x and y directly.
-          May be used for maps of flat surfaces (e.g. game maps). Note that the y axis
-          should still be inverted (going from bottom to top).
+        May be used for maps of flat surfaces (e.g. game maps). Note that the y axis
+        should still be inverted (going from bottom to top).
 
     Returns
     -------
@@ -229,6 +231,7 @@ class TileLayer(Layer):
             - "Cloudmade" (Must pass API key)
             - "Mapbox" (Must pass API key)
             - "CartoDB" (positron and dark_matter)
+
         You can pass a custom tileset to Folium by passing a Leaflet-style
         URL to the tiles parameter:
         http://{s}.yourtiles.com/{z}/{x}/{y}.png
@@ -381,18 +384,20 @@ class Icon(MacroElement):
     ----------
     color : str, default 'blue'
         The color of the marker. You can use:
+
             ['red', 'blue', 'green', 'purple', 'orange', 'darkred',
              'lightred', 'beige', 'darkblue', 'darkgreen', 'cadetblue',
              'darkpurple', 'white', 'pink', 'lightblue', 'lightgreen',
              'gray', 'black', 'lightgray']
+
     icon_color : str, default 'white'
         The color of the drawing on the marker. You can use colors above,
         or an html color code.
     icon : str, default 'info-sign'
         The name of the marker sign.
         See Font-Awesome website to choose yours.
         Warning : depending on the icon you choose you may need to adapt
-                  the `prefix` as well.
+        the `prefix` as well.
     angle : int, default 0
         The icon will be rotated by this amount of degrees.
     prefix : str, default 'glyphicon'