Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove duplicate parameter EXIF from JPEG #6585

Closed
wants to merge 2 commits into from

Conversation

melonmouse
Copy link

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

@radarhere radarhere changed the title Remove duplicate parameter exif from jpeg. Remove duplicate parameter EXIF from JPEG Sep 16, 2022
@radarhere
Copy link
Member

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.

@melonmouse
Copy link
Author

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?

@radarhere
Copy link
Member

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.

@melonmouse
Copy link
Author

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:

@radarhere
Copy link
Member

@radarhere
Copy link
Member

#6632 has now been merged.

@radarhere radarhere closed this Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants