Skip to content

Commit 4bbb395

Browse files
committed
improve docs output
1 parent a63ed13 commit 4bbb395

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

folium/features.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1864,12 +1864,12 @@ class CustomIcon(Icon):
18641864
----------
18651865
icon_image : string or array-like object
18661866
The data to use as an icon.
1867-
* If string is a path to an image file, its content will be converted and
1868-
embedded.
1869-
* If string is a URL, it will be linked.
1870-
* Otherwise a string will be assumed to be JSON and embedded.
1871-
* If array-like, it will be converted to PNG base64 string and embedded.
18721867
1868+
* If string is a path to an image file, its content will be converted and
1869+
embedded.
1870+
* If string is a URL, it will be linked.
1871+
* Otherwise a string will be assumed to be JSON and embedded.
1872+
* If array-like, it will be converted to PNG base64 string and embedded.
18731873
icon_size : tuple of 2 int, optional
18741874
Size of the icon image in pixels.
18751875
icon_anchor : tuple of 2 int, optional

folium/raster_layers.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -245,14 +245,15 @@ class ImageOverlay(Layer):
245245
----------
246246
image: string or array-like object
247247
The data to overlay as an image.
248-
* If string is a path to an image file, its content will be converted and
249-
embedded.
250-
* If string is a URL, it will be linked.
251-
* Otherwise a string will be assumed to be JSON and embedded.
252-
* If array-like, it will be converted to PNG base64 string and embedded.
248+
249+
* If string is a path to an image file, its content will be converted and
250+
embedded.
251+
* If string is a URL, it will be linked.
252+
* Otherwise a string will be assumed to be JSON and embedded.
253+
* If array-like, it will be converted to PNG base64 string and embedded.
253254
bounds: list/tuple of list/tuple of float
254255
Image bounds on the map in the form
255-
[[lat_min, lon_min], [lat_max, lon_max]]
256+
[[lat_min, lon_min], [lat_max, lon_max]]
256257
opacity: float, default Leaflet's default (1.0)
257258
alt: string, default Leaflet's default ('')
258259
origin: ['upper' | 'lower'], optional, default 'upper'

folium/utilities.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -170,14 +170,13 @@ def image_to_url(
170170
Parameters
171171
----------
172172
image: string or array-like object
173-
* If string is a path to an image file, its content will be converted and
174-
embedded in the output URL.
175-
* If string is a URL, it will be linked in the output URL.
176-
* Otherwise a string will be assumed to be JSON and embedded in the
177-
output URL.
178-
* If array-like, it will be converted to PNG base64 string and embedded in the
179-
output URL.
180-
173+
* If string is a path to an image file, its content will be converted and
174+
embedded in the output URL.
175+
* If string is a URL, it will be linked in the output URL.
176+
* Otherwise a string will be assumed to be JSON and embedded in the
177+
output URL.
178+
* If array-like, it will be converted to PNG base64 string and embedded in the
179+
output URL.
181180
origin: ['upper' | 'lower'], optional, default 'upper'
182181
Place the [0, 0] index of the array in the upper left or
183182
lower left corner of the axes.

0 commit comments

Comments
 (0)