Skip to content

Commit 827f01f

Browse files
committed
Docs: Fix #2905 utilities.image_to_url() image parameter documentation issues
1 parent b2cb81a commit 827f01f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

folium/utilities.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -169,12 +169,14 @@ def image_to_url(
169169
170170
Parameters
171171
----------
172-
image: string, file or array-like object
173-
* If string, it will be written directly in the output file.
174-
* If file, it's content will be converted as embedded in the
175-
output file.
176-
* If array-like, it will be converted to PNG base64 string and
177-
embedded in the output.
172+
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 output URL.
177+
* If array-like, it will be converted to PNG base64 string and embedded in the
178+
output URL.
179+
178180
origin: ['upper' | 'lower'], optional, default 'upper'
179181
Place the [0, 0] index of the array in the upper left or
180182
lower left corner of the axes.

0 commit comments

Comments
 (0)