Skip to content

Commit 683004c

Browse files
committed
Update imread docstring for URL strings.
1 parent 11f7925 commit 683004c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

lib/matplotlib/image.py

+6-3
Original file line numberDiff line numberDiff line change
@@ -1204,8 +1204,9 @@ def imread(fname, format=None):
12041204
"""
12051205
Read an image from a file into an array.
12061206
1207-
*fname* may be a string path or a Python file-like object. If
1208-
using a file object, it must be opened in binary mode.
1207+
*fname* may be a string path, a valid URL, or a Python
1208+
file-like object. If using a file object, it must be opened in binary
1209+
mode.
12091210
12101211
If *format* is provided, will try to read file of that type,
12111212
otherwise the format is deduced from the filename. If nothing can
@@ -1218,7 +1219,9 @@ def imread(fname, format=None):
12181219
matplotlib can only read PNGs natively, but if `PIL
12191220
<http://www.pythonware.com/products/pil/>`_ is installed, it will
12201221
use it to load the image and return an array (if possible) which
1221-
can be used with :func:`~matplotlib.pyplot.imshow`.
1222+
can be used with :func:`~matplotlib.pyplot.imshow`. Note, URL strings
1223+
may not be compatible with PIL. Check the PIL documentation for more
1224+
information.
12221225
"""
12231226

12241227
def pilread(fname):

0 commit comments

Comments
 (0)