Pillow icon indicating copy to clipboard operation
Pillow copied to clipboard

Remove duplicate parameter EXIF from JPEG

Open melonmouse opened this issue 2 years ago • 4 comments

Small improvement of the docs. Have a nice day :)

melonmouse avatar Sep 16 '22 08:09 melonmouse

The first mention of EXIF is listed under The open() method may set the following info properties if available: The second is listed under The save() method supports the following options:

This is not a duplication. It is mentioned twice because it can be used in two different ways.

radarhere avatar Sep 16 '22 08:09 radarhere

Ah thanks for the clarification! I guess I read over those because "The save/load method supports the following options:" looks to me to be a part of the header above/below it - rather than being their semantic header. Would it make sense to elevate those to headers with a fontsize in between the parameter names and the image format header?

melonmouse avatar Sep 16 '22 09:09 melonmouse

The :py:meth:`~PIL.Image.Image.save` method supports the following options:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

renders as a <h4>.

Screen Shot 2022-09-16 at 7 53 17 pm

I personally feel like that's a bit much?

This also turns it into a <section> and adds an anchor tag.

radarhere avatar Sep 16 '22 09:09 radarhere

How about the following? I think the thing you propose is already a big win for readability of the docs, but maybe this is a bit neater.

The :py:meth:`~PIL.Image.Image.save` method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The :py:meth:`~PIL.Image.Image.save` method supports the following options:

melonmouse avatar Sep 16 '22 10:09 melonmouse

What do you think of PR #6632 / https://pillow--6632.org.readthedocs.build/en/6632/handbook/image-file-formats.html#jpeg?

radarhere avatar Oct 01 '22 10:10 radarhere

#6632 has now been merged.

radarhere avatar Oct 02 '22 22:10 radarhere