Merge pull request #116 from pbugnion/geojson-geometries-api-docs

GeoJSON geometries api docs
pbugnion · Mar 12, 2017 · 1176c8f · 1176c8f
2 parents 1fbdd3e + 6dd285b
commit 1176c8f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -47,8 +47,13 @@ Datasets
 --------
 
 .. automodule:: gmaps.datasets
-   :members: list_datasets, load_dataset, dataset_metadata, load_dataset_as_df
+   :members: list_datasets, dataset_metadata, load_dataset, load_dataset_as_df
 
+GeoJSON geometries
+------------------
+
+.. automodule:: gmaps.geojson_geometries
+   :members: list_geometries, geometry_metadata, load_geometry
 
 Traitlets
 ---------

diff --git a/gmaps/geojson_geometries/geojson_geometries.py b/gmaps/geojson_geometries/geojson_geometries.py
@@ -84,6 +84,24 @@ def geometry_metadata(geometry_name):
 
 
 def load_geometry(geometry_name):
+    """
+    Fetch a geometry.
+
+    :returns:
+        A python dictionary containing the geometry.
+
+    :Examples:
+
+    >>> import gmaps
+    >>> import gmaps.geojson_geometries
+    >>> gmaps.configure(api_key="AIza...")
+    >>> countries_geojson = gmaps.geojson_geometries.load_geometry('countries')
+
+    >>> m = gmaps.Map()
+    >>> gini_layer = gmaps.geojson_layer(countries_geojson)
+    >>> m.add_layer(gini_layer)
+    >>> m
+    """
     url = METADATA[geometry_name]["url"]
     reader = codecs.getreader("utf-8")
     f = urlopen(url)