Skip to content

Commit 26b2aa5

Browse files
committed
document ImageCms.{ImageCmsProfile,Intent,Direction}; fix ImageCms.core.CmsProfile references
(cherry picked from commit f2b1bbc)
1 parent 9099142 commit 26b2aa5

3 files changed

Lines changed: 23 additions & 4 deletions

File tree

docs/deprecations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -338,8 +338,8 @@ ImageCms.CmsProfile attributes
338338
.. deprecated:: 3.2.0
339339
.. versionremoved:: 8.0.0
340340

341-
Some attributes in :py:class:`PIL.ImageCms.CmsProfile` have been removed. From 6.0.0,
342-
they issued a :py:exc:`DeprecationWarning`:
341+
Some attributes in :py:class:`PIL.ImageCms.core.CmsProfile` have been removed.
342+
From 6.0.0, they issued a :py:exc:`DeprecationWarning`:
343343

344344
======================== ===================================================
345345
Removed Use instead

docs/reference/ImageCms.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,26 @@ The :py:mod:`~PIL.ImageCms` module provides color profile management
88
support using the LittleCMS2 color management engine, based on Kevin
99
Cazabon's PyCMS library.
1010

11+
.. autoclass:: ImageCmsProfile
12+
:members:
13+
:special-members: __init__
1114
.. autoclass:: ImageCmsTransform
15+
:members:
16+
:undoc-members:
1217
.. autoexception:: PyCMSError
1318

19+
Constants
20+
---------
21+
22+
.. autoclass:: Intent
23+
:members:
24+
:member-order: bysource
25+
:undoc-members:
26+
.. autoclass:: Direction
27+
:members:
28+
:member-order: bysource
29+
:undoc-members:
30+
1431
Functions
1532
---------
1633

@@ -37,13 +54,15 @@ CmsProfile
3754
----------
3855

3956
The ICC color profiles are wrapped in an instance of the class
40-
:py:class:`CmsProfile`. The specification ICC.1:2010 contains more
57+
:py:class:`~core.CmsProfile`. The specification ICC.1:2010 contains more
4158
information about the meaning of the values in ICC profiles.
4259

4360
For convenience, all XYZ-values are also given as xyY-values (so they
4461
can be easily displayed in a chromaticity diagram, for example).
4562

63+
.. py:currentmodule:: PIL.ImageCms.core
4664
.. py:class:: CmsProfile
65+
:canonical: PIL._imagingcms.CmsProfile
4766

4867
.. py:attribute:: creation_date
4968
:type: Optional[datetime.datetime]

docs/releasenotes/8.0.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Image.fromstring, im.fromstring and im.tostring
3030
ImageCms.CmsProfile attributes
3131
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3232

33-
Some attributes in :py:class:`PIL.ImageCms.CmsProfile` have been removed:
33+
Some attributes in :py:class:`PIL.ImageCms.core.CmsProfile` have been removed:
3434

3535
======================== ===================================================
3636
Removed Use instead

0 commit comments

Comments
 (0)