update docs (#110) (#118)

* update docs (#110) * remove rouge letters
fmaussion · Jul 26, 2018 · 38ea895 · 38ea895
1 parent ce49490
commit 38ea895
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 7 deletions.
diff --git a/salem/datasets.py b/salem/datasets.py
@@ -494,10 +494,11 @@ def __init__(self, center_ll=(11.38, 47.26), size_x=640, size_y=640,
         size_y : int
           image size
         scale : int
-          image scaling factor
-        zoom int
+          image scaling factor. 1, 2. 2 is higher resolution but takes 
+          longer to download
+        zoom : int
           google zoom level (https://developers.google.com/maps/documentation/
-          static-maps/intro#Zoomlevels)
+          static-maps/intro#Zoomlevels). 1 (world) - 20 (buildings)
         maptype : str, default: 'satellite'
           'roadmap', 'satellite', 'hybrid', 'terrain'
         use_cache : bool, default: True
@@ -508,8 +509,8 @@ def __init__(self, center_ll=(11.38, 47.26), size_x=640, size_y=640,
 
         # Google grid
         grid = gis.googlestatic_mercator_grid(center_ll=center_ll,
-                                                nx=size_x, ny=size_y,
-                                                zoom=zoom, scale=scale)
+                                              nx=size_x, ny=size_y,
+                                              zoom=zoom, scale=scale)
 
         # Motionless
         googleurl = motionless.CenterMap(lon=center_ll[0], lat=center_ll[1],
@@ -560,13 +561,19 @@ def __init__(self, x, y, crs=wgs84, size_x=640, size_y=640, scale=1,
         size_y : int
           image size
         scale : int
-          image scaling factor
+          image scaling factor. 1, 2. 2 is higher resolution but takes
+          longer to download
         maptype : str, default: 'satellite'
           'roadmap', 'satellite', 'hybrid', 'terrain'
         use_cache : bool, default: True
           store the downloaded image in the cache to avoid future downloads
         kwargs : **
           any keyword accepted by motionless.CenterMap (e.g. `key` for the API)
+
+        Note
+        ----
+        To obtain the exact domain specified in `x` and `y` you may have to
+        play with the `size_x` and `size_y` kwargs.
         """
 
         if 'zoom' in kwargs or 'center_ll' in kwargs:

diff --git a/salem/graphics.py b/salem/graphics.py
@@ -411,7 +411,8 @@ def __init__(self, grid, nx=500, ny=None, factor=None,
         ny : int
           y resolution (in pixels) of the map (ignored if nx is set)
         factor : float
-          shortcut to keep the same image resolution as the grid
+          shortcut to keep the same image resolution as the grid.
+          1 prevents image resizing
         countries : bool
           automatically add country borders to the map (you can do
           it later with a call to set_shapefile)