From 52cbd123a2674f4e82678b2a6050b20d7092d04d Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Wed, 7 Jan 2015 04:12:37 +0500 Subject: [PATCH] DOC fix "Write Your Own File Decoder" link in Image API docs --- PIL/Image.py | 2 +- docs/handbook/writing-your-own-file-decoder.rst | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/PIL/Image.py b/PIL/Image.py index 98e3644c0..66149e320 100644 --- a/PIL/Image.py +++ b/PIL/Image.py @@ -2024,7 +2024,7 @@ def frombytes(mode, size, data, decoder_name="raw", *args): You can also use any pixel decoder supported by PIL. For more information on available decoders, see the section - **Writing Your Own File Decoder**. + :ref:`Writing Your Own File Decoder `. Note that this function decodes pixel data only, not entire images. If you have an entire image in a string, wrap it in a diff --git a/docs/handbook/writing-your-own-file-decoder.rst b/docs/handbook/writing-your-own-file-decoder.rst index f871ac521..0af4007be 100644 --- a/docs/handbook/writing-your-own-file-decoder.rst +++ b/docs/handbook/writing-your-own-file-decoder.rst @@ -1,4 +1,6 @@ -Writing your own file decoder +.. _file-decoders: + +Writing Your Own File Decoder ============================= The Python Imaging Library uses a plug-in model which allows you to @@ -7,7 +9,7 @@ library itself. Such plug-ins usually have names like :file:`XxxImagePlugin.py`, where ``Xxx`` is a unique format name (usually an abbreviation). -.. warning:: Pillow >= 2.1.0 no longer automatically imports any file in the Python path with a name ending in :file:`ImagePlugin.py`. You will need to import your decoder manually. +.. warning:: Pillow >= 2.1.0 no longer automatically imports any file in the Python path with a name ending in :file:`ImagePlugin.py`. You will need to import your decoder manually. A decoder plug-in should contain a decoder class, based on the :py:class:`PIL.ImageFile.ImageFile` base class. This class should provide an @@ -68,7 +70,7 @@ true color. ] Image.register_open("SPAM", SpamImageFile) - + Image.register_extension("SPAM", ".spam") Image.register_extension("SPAM", ".spa") # dos version @@ -125,7 +127,7 @@ TIFF, and many others. To use the raw decoder with the :py:func:`PIL.Image.fromstring` function, use the following syntax:: image = Image.fromstring( - mode, size, data, "raw", + mode, size, data, "raw", raw mode, stride, orientation )