Updated docstrings

This commit is contained in:
Andrew Murray 2015-08-05 22:32:15 +10:00
parent cf4145e2c9
commit 7775ff3ac7

View File

@ -1640,7 +1640,7 @@ class Image(object):
implement the ``seek``, ``tell``, and ``write`` implement the ``seek``, ``tell``, and ``write``
methods, and be opened in binary mode. methods, and be opened in binary mode.
:param fp: File name or file object. :param fp: A filename (string), pathlib.Path object or file object.
:param format: Optional format override. If omitted, the :param format: Optional format override. If omitted, the
format to use is determined from the filename extension. format to use is determined from the filename extension.
If a file object was used instead of a filename, this If a file object was used instead of a filename, this
@ -2267,9 +2267,9 @@ def open(fp, mode="r"):
:py:meth:`~PIL.Image.Image.load` method). See :py:meth:`~PIL.Image.Image.load` method). See
:py:func:`~PIL.Image.new`. :py:func:`~PIL.Image.new`.
:param fp: A filename (string) or a file object. The file object :param fp: A filename (string), pathlib.Path object or a file object.
must implement :py:meth:`~file.read`, :py:meth:`~file.seek`, and The file object must implement :py:meth:`~file.read`, :py:meth:`~file.seek`,
:py:meth:`~file.tell` methods, and be opened in binary mode. and :py:meth:`~file.tell` methods, and be opened in binary mode.
:param mode: The mode. If given, this argument must be "r". :param mode: The mode. If given, this argument must be "r".
:returns: An :py:class:`~PIL.Image.Image` object. :returns: An :py:class:`~PIL.Image.Image` object.
:exception IOError: If the file cannot be found, or the image cannot be :exception IOError: If the file cannot be found, or the image cannot be