mirror of
https://github.com/python-pillow/Pillow.git
synced 2024-12-26 01:46:18 +03:00
use cross-reference for None value
This commit is contained in:
parent
09a87161a2
commit
9589159585
|
@ -857,7 +857,7 @@ The :py:meth:`~PIL.Image.Image.save` method can take the following keyword argum
|
||||||
**compression**
|
**compression**
|
||||||
A string containing the desired compression method for the
|
A string containing the desired compression method for the
|
||||||
file. (valid only with libtiff installed) Valid compression
|
file. (valid only with libtiff installed) Valid compression
|
||||||
methods are: ``None``, ``"tiff_ccitt"``, ``"group3"``,
|
methods are: :data:`None`, ``"tiff_ccitt"``, ``"group3"``,
|
||||||
``"group4"``, ``"tiff_jpeg"``, ``"tiff_adobe_deflate"``,
|
``"group4"``, ``"tiff_jpeg"``, ``"tiff_adobe_deflate"``,
|
||||||
``"tiff_thunderscan"``, ``"tiff_deflate"``, ``"tiff_sgilog"``,
|
``"tiff_thunderscan"``, ``"tiff_deflate"``, ``"tiff_sgilog"``,
|
||||||
``"tiff_sgilog24"``, ``"tiff_raw_16"``
|
``"tiff_sgilog24"``, ``"tiff_raw_16"``
|
||||||
|
|
|
@ -132,7 +132,7 @@ The fields are used as follows:
|
||||||
**parameters**
|
**parameters**
|
||||||
Parameters to the decoder. The contents of this field depends on the
|
Parameters to the decoder. The contents of this field depends on the
|
||||||
decoder specified by the first field in the tile descriptor tuple. If the
|
decoder specified by the first field in the tile descriptor tuple. If the
|
||||||
decoder doesn’t need any parameters, use ``None`` for this field.
|
decoder doesn’t need any parameters, use :data:`None` for this field.
|
||||||
|
|
||||||
Note that the :py:attr:`tile` attribute contains a list of tile descriptors,
|
Note that the :py:attr:`tile` attribute contains a list of tile descriptors,
|
||||||
not just a single descriptor.
|
not just a single descriptor.
|
||||||
|
|
|
@ -285,7 +285,7 @@ Instances of the :py:class:`Image` class have the following attributes:
|
||||||
|
|
||||||
The file format of the source file. For images created by the library
|
The file format of the source file. For images created by the library
|
||||||
itself (via a factory function, or by running a method on an existing
|
itself (via a factory function, or by running a method on an existing
|
||||||
image), this attribute is set to ``None``.
|
image), this attribute is set to :data:`None`.
|
||||||
|
|
||||||
.. py:attribute:: Image.mode
|
.. py:attribute:: Image.mode
|
||||||
:type: str
|
:type: str
|
||||||
|
@ -314,7 +314,7 @@ Instances of the :py:class:`Image` class have the following attributes:
|
||||||
|
|
||||||
Colour palette table, if any. If mode is "P" or "PA", this should be an
|
Colour palette table, if any. If mode is "P" or "PA", this should be an
|
||||||
instance of the :py:class:`~PIL.ImagePalette.ImagePalette` class.
|
instance of the :py:class:`~PIL.ImagePalette.ImagePalette` class.
|
||||||
Otherwise, it should be set to ``None``.
|
Otherwise, it should be set to :data:`None`.
|
||||||
|
|
||||||
.. py:attribute:: Image.info
|
.. py:attribute:: Image.info
|
||||||
:type: dict
|
:type: dict
|
||||||
|
|
|
@ -212,7 +212,7 @@ Methods
|
||||||
.. versionadded:: 1.1.5
|
.. versionadded:: 1.1.5
|
||||||
|
|
||||||
.. note:: This option was broken until version 1.1.6.
|
.. note:: This option was broken until version 1.1.6.
|
||||||
:param joint: Joint type between a sequence of lines. It can be ``"curve"``, for rounded edges, or ``None``.
|
:param joint: Joint type between a sequence of lines. It can be ``"curve"``, for rounded edges, or :data:`None`.
|
||||||
|
|
||||||
.. versionadded:: 5.3.0
|
.. versionadded:: 5.3.0
|
||||||
|
|
||||||
|
|
|
@ -27,7 +27,7 @@ or the clipboard to a PIL image memory.
|
||||||
.. versionadded:: 6.2.0
|
.. versionadded:: 6.2.0
|
||||||
|
|
||||||
:param xdisplay:
|
:param xdisplay:
|
||||||
X11 Display address. Pass ``None`` to grab the default system screen. Pass ``""`` to grab the default X11 screen on Windows or macOS.
|
X11 Display address. Pass :data:`None` to grab the default system screen. Pass ``""`` to grab the default X11 screen on Windows or macOS.
|
||||||
|
|
||||||
You can check X11 support using :py:func:`PIL.features.check_feature` with ``feature="xcb"``.
|
You can check X11 support using :py:func:`PIL.features.check_feature` with ``feature="xcb"``.
|
||||||
|
|
||||||
|
|
|
@ -34,7 +34,7 @@ Curved joints for line sequences
|
||||||
``ImageDraw.Draw.line`` draws a line, or lines, between points. Previously,
|
``ImageDraw.Draw.line`` draws a line, or lines, between points. Previously,
|
||||||
when multiple points are given, for a larger ``width``, the joints between
|
when multiple points are given, for a larger ``width``, the joints between
|
||||||
these lines looked unsightly. There is now an additional optional argument,
|
these lines looked unsightly. There is now an additional optional argument,
|
||||||
``joint``, defaulting to ``None``. When it is set to ``curved``, the joints
|
``joint``, defaulting to :data:`None`. When it is set to ``curved``, the joints
|
||||||
between the lines will become rounded.
|
between the lines will become rounded.
|
||||||
|
|
||||||
ImageOps.colorize
|
ImageOps.colorize
|
||||||
|
|
|
@ -66,7 +66,7 @@ See :ref:`concept-filters` to learn the difference. In short,
|
||||||
Image.draft() return value
|
Image.draft() return value
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
If the :py:meth:`~PIL.Image.Image.draft` method has no effect, it returns ``None``.
|
If the :py:meth:`~PIL.Image.Image.draft` method has no effect, it returns :data:`None`.
|
||||||
If it does have an effect, then it previously returned the image itself.
|
If it does have an effect, then it previously returned the image itself.
|
||||||
However, unlike other `chain methods`_, :py:meth:`~PIL.Image.Image.draft` does not
|
However, unlike other `chain methods`_, :py:meth:`~PIL.Image.Image.draft` does not
|
||||||
return a modified version of the image, but modifies it in-place. So instead, if
|
return a modified version of the image, but modifies it in-place. So instead, if
|
||||||
|
@ -95,7 +95,7 @@ the closer the result to the fair resampling. The smaller ``reducing_gap``,
|
||||||
the faster resizing. With ``reducing_gap`` greater or equal to 3.0,
|
the faster resizing. With ``reducing_gap`` greater or equal to 3.0,
|
||||||
the result is indistinguishable from fair resampling.
|
the result is indistinguishable from fair resampling.
|
||||||
|
|
||||||
The default value for :py:meth:`~PIL.Image.Image.resize` is ``None``,
|
The default value for :py:meth:`~PIL.Image.Image.resize` is :data:`None`,
|
||||||
which means that the optimization is turned off by default.
|
which means that the optimization is turned off by default.
|
||||||
|
|
||||||
The default value for :py:meth:`~PIL.Image.Image.thumbnail` is 2.0,
|
The default value for :py:meth:`~PIL.Image.Image.thumbnail` is 2.0,
|
||||||
|
|
|
@ -63,7 +63,7 @@ Support has been added for ``ImageGrab.grab()`` on Linux using the X server
|
||||||
with the XCB library.
|
with the XCB library.
|
||||||
|
|
||||||
An optional ``xdisplay`` parameter has been added to select the X server,
|
An optional ``xdisplay`` parameter has been added to select the X server,
|
||||||
with the default value of ``None`` using the default X server.
|
with the default value of :data:`None` using the default X server.
|
||||||
|
|
||||||
Passing a different value on Windows or macOS will force taking a snapshot
|
Passing a different value on Windows or macOS will force taking a snapshot
|
||||||
using the selected X server; pass an empty string to use the default X server.
|
using the selected X server; pass an empty string to use the default X server.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user