Skip to content

Add docs for features module#4688

Merged
hugovk merged 2 commits intopython-pillow:masterfrom
nulano:featers-docs
Jun 15, 2020
Merged

Add docs for features module#4688
hugovk merged 2 commits intopython-pillow:masterfrom
nulano:featers-docs

Conversation

@nulano
Copy link
Contributor

@nulano nulano commented Jun 13, 2020

This PR adds documentation for the features module. The only other reference to it before was in the 5.4.0 release docs.

.. versionadded:: 1.1.3

.. py:function:: PIL.ImageGrab.grab(bbox=None, include_layered_windows=False, all_screens=False, xdisplay=None)
.. py:function:: grab(bbox=None, include_layered_windows=False, all_screens=False, xdisplay=None)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is necessary to fix links. It also fixes the source button in the docs.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some little nits


* ``jpg``: (compile time) LibJpeg support, required for JPEG based image formats.
* ``jpg_2000``: (compile time) OpenJpeg support, required for JPEG 2000 image formats.
* ``zlib``: (compile time) ZLib support, required for ZLib compressed formats, such as PNG.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* ``zlib``: (compile time) ZLib support, required for ZLib compressed formats, such as PNG.
* ``zlib``: (compile time) zlib support, required for zlib compressed formats, such as PNG.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went with "Zlib" for the first one, as it is the start of a sentence.

Co-authored-by: Hugo <hugovk@users.noreply.github.com>
@nulano
Copy link
Contributor Author

nulano commented Jun 14, 2020

I would also like to propose adding a public API for checking library versions and including version numbers in pilinfo. Should I add it here or open a new PR (that depends on this PR due to docs)?

@hugovk
Copy link
Member

hugovk commented Jun 15, 2020

Let's merge this and you can open a new PR.

Thanks!

@hugovk hugovk merged commit d6be133 into python-pillow:master Jun 15, 2020
@nulano nulano deleted the featers-docs branch June 27, 2020 15:51
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.

3 participants