Skip to content

Commit 936660a

Browse files
author
Martin Journois
committed
Improve Mercator docstring
1 parent 72586fe commit 936660a

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

folium/plugins/image_overlay.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ def mercator_transform(data, lat_bounds, origin='upper', height_out=None):
2525
2626
lat_bounds : length 2 tuple
2727
Minimal and maximal value of the latitude of the image.
28+
Bounds must be between -85.051128779806589 and 85.051128779806589
29+
otherwise they will be clipped to that values.
2830
2931
origin : ['upper' | 'lower'], optional, default 'upper'
3032
Place the [0,0] index of the array in the upper left or lower left
@@ -33,6 +35,8 @@ def mercator_transform(data, lat_bounds, origin='upper', height_out=None):
3335
height_out : int, default None
3436
The expected height of the output.
3537
If None, the height of the input is used.
38+
39+
See https://en.wikipedia.org/wiki/Web_Mercator for more details.
3640
"""
3741
import numpy as np
3842

0 commit comments

Comments
 (0)