Skip to content

Commit 348589a

Browse files
hugovkradarhere
hugovk
and
radarhere
authored
Docs: use sentence case for headers (#8914)
Co-authored-by: Andrew Murray <[email protected]>
1 parent d03ce3d commit 348589a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+313
-313
lines changed

‎Tests/README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Pillow Tests
1+
Pillow tests
22
============
33

44
Test scripts are named ``test_xxx.py``. Helper classes and functions can be found in ``helper.py``.

‎docs/PIL.rst

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,66 @@
1-
PIL Package (autodoc of remaining modules)
1+
PIL package (autodoc of remaining modules)
22
==========================================
33

44
Reference for modules whose documentation has not yet been ported or written
55
can be found here.
66

7-
:mod:`PIL` Module
7+
:mod:`PIL` module
88
-----------------
99

1010
.. py:module:: PIL
1111
1212
.. autoexception:: UnidentifiedImageError
1313
:show-inheritance:
1414

15-
:mod:`~PIL.BdfFontFile` Module
15+
:mod:`~PIL.BdfFontFile` module
1616
------------------------------
1717

1818
.. automodule:: PIL.BdfFontFile
1919
:members:
2020
:undoc-members:
2121
:show-inheritance:
2222

23-
:mod:`~PIL.ContainerIO` Module
23+
:mod:`~PIL.ContainerIO` module
2424
------------------------------
2525

2626
.. automodule:: PIL.ContainerIO
2727
:members:
2828
:undoc-members:
2929
:show-inheritance:
3030

31-
:mod:`~PIL.FontFile` Module
31+
:mod:`~PIL.FontFile` module
3232
---------------------------
3333

3434
.. automodule:: PIL.FontFile
3535
:members:
3636
:undoc-members:
3737
:show-inheritance:
3838

39-
:mod:`~PIL.GdImageFile` Module
39+
:mod:`~PIL.GdImageFile` module
4040
------------------------------
4141

4242
.. automodule:: PIL.GdImageFile
4343
:members:
4444
:undoc-members:
4545
:show-inheritance:
4646

47-
:mod:`~PIL.GimpGradientFile` Module
47+
:mod:`~PIL.GimpGradientFile` module
4848
-----------------------------------
4949

5050
.. automodule:: PIL.GimpGradientFile
5151
:members:
5252
:undoc-members:
5353
:show-inheritance:
5454

55-
:mod:`~PIL.GimpPaletteFile` Module
55+
:mod:`~PIL.GimpPaletteFile` module
5656
----------------------------------
5757

5858
.. automodule:: PIL.GimpPaletteFile
5959
:members:
6060
:undoc-members:
6161
:show-inheritance:
6262

63-
:mod:`~PIL.ImageDraw2` Module
63+
:mod:`~PIL.ImageDraw2` module
6464
-----------------------------
6565

6666
.. automodule:: PIL.ImageDraw2
@@ -69,31 +69,31 @@ can be found here.
6969
:undoc-members:
7070
:show-inheritance:
7171

72-
:mod:`~PIL.ImageMode` Module
72+
:mod:`~PIL.ImageMode` module
7373
----------------------------
7474

7575
.. automodule:: PIL.ImageMode
7676
:members:
7777
:undoc-members:
7878
:show-inheritance:
7979

80-
:mod:`~PIL.PaletteFile` Module
80+
:mod:`~PIL.PaletteFile` module
8181
------------------------------
8282

8383
.. automodule:: PIL.PaletteFile
8484
:members:
8585
:undoc-members:
8686
:show-inheritance:
8787

88-
:mod:`~PIL.PcfFontFile` Module
88+
:mod:`~PIL.PcfFontFile` module
8989
------------------------------
9090

9191
.. automodule:: PIL.PcfFontFile
9292
:members:
9393
:undoc-members:
9494
:show-inheritance:
9595

96-
:class:`.PngImagePlugin.iTXt` Class
96+
:class:`.PngImagePlugin.iTXt` class
9797
-----------------------------------
9898

9999
.. autoclass:: PIL.PngImagePlugin.iTXt
@@ -107,7 +107,7 @@ can be found here.
107107
:param lang: language code
108108
:param tkey: UTF-8 version of the key name
109109

110-
:class:`.PngImagePlugin.PngInfo` Class
110+
:class:`.PngImagePlugin.PngInfo` class
111111
--------------------------------------
112112

113113
.. autoclass:: PIL.PngImagePlugin.PngInfo
@@ -116,15 +116,15 @@ can be found here.
116116
:show-inheritance:
117117

118118

119-
:mod:`~PIL.TarIO` Module
119+
:mod:`~PIL.TarIO` module
120120
------------------------
121121

122122
.. automodule:: PIL.TarIO
123123
:members:
124124
:undoc-members:
125125
:show-inheritance:
126126

127-
:mod:`~PIL.WalImageFile` Module
127+
:mod:`~PIL.WalImageFile` module
128128
-------------------------------
129129

130130
.. automodule:: PIL.WalImageFile

‎docs/deprecations.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ JpegImageFile.huffman_ac and JpegImageFile.huffman_dc
155155
The ``huffman_ac`` and ``huffman_dc`` dictionaries on JPEG images were unused. They
156156
have been deprecated, and will be removed in Pillow 12 (2025-10-15).
157157

158-
Specific WebP Feature Checks
158+
Specific WebP feature checks
159159
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
160160

161161
.. deprecated:: 11.0.0

‎docs/handbook/concepts.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ pixels.
8484

8585
.. _coordinate-system:
8686

87-
Coordinate System
87+
Coordinate system
8888
-----------------
8989

9090
The Python Imaging Library uses a Cartesian pixel coordinate system, with (0,0)

‎docs/handbook/image-file-formats.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1222,7 +1222,7 @@ numbers are returned as a tuple of ``(numerator, denominator)``.
12221222

12231223
.. deprecated:: 3.0.0
12241224

1225-
Reading Multi-frame TIFF Images
1225+
Reading multi-frame TIFF images
12261226
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12271227

12281228
The TIFF loader supports the :py:meth:`~PIL.Image.Image.seek` and
@@ -1664,7 +1664,7 @@ The :py:meth:`~PIL.Image.open` method sets the following
16641664
Transparency color index. This key is omitted if the image is not
16651665
transparent.
16661666

1667-
XV Thumbnails
1667+
XV thumbnails
16681668
^^^^^^^^^^^^^
16691669

16701670
Pillow can read XV thumbnail files.

‎docs/handbook/overview.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ processing tool.
1313

1414
Let’s look at a few possible uses of this library.
1515

16-
Image Archives
16+
Image archives
1717
--------------
1818

1919
The Python Imaging Library is ideal for image archival and batch processing
@@ -24,7 +24,7 @@ The current version identifies and reads a large number of formats. Write
2424
support is intentionally restricted to the most commonly used interchange and
2525
presentation formats.
2626

27-
Image Display
27+
Image display
2828
-------------
2929

3030
The current release includes Tk :py:class:`~PIL.ImageTk.PhotoImage` and
@@ -36,7 +36,7 @@ support.
3636
For debugging, there’s also a :py:meth:`~PIL.Image.Image.show` method which saves an image to
3737
disk, and calls an external display utility.
3838

39-
Image Processing
39+
Image processing
4040
----------------
4141

4242
The library contains basic image processing functionality, including point operations, filtering with a set of built-in convolution kernels, and colour space conversions.

‎docs/handbook/tutorial.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ This means that opening an image file is a fast operation, which is independent
122122
of the file size and compression type. Here’s a simple script to quickly
123123
identify a set of image files:
124124

125-
Identify Image Files
125+
Identify image files
126126
^^^^^^^^^^^^^^^^^^^^
127127

128128
::
@@ -399,7 +399,7 @@ Applying filters
399399
.. image:: enhanced_hopper.webp
400400
:align: center
401401

402-
Point Operations
402+
Point operations
403403
^^^^^^^^^^^^^^^^
404404

405405
The :py:meth:`~PIL.Image.Image.point` method can be used to translate the pixel

‎docs/handbook/writing-your-own-image-plugin.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _image-plugins:
22

3-
Writing Your Own Image Plugin
3+
Writing your own image plugin
44
=============================
55

66
Pillow uses a plugin model which allows you to add your own
@@ -329,7 +329,7 @@ The fields are used as follows:
329329

330330
.. _file-codecs:
331331

332-
Writing Your Own File Codec in C
332+
Writing your own file codec in C
333333
================================
334334

335335
There are 3 stages in a file codec's lifetime:
@@ -414,7 +414,7 @@ memory and release any resources from external libraries.
414414

415415
.. _file-codecs-py:
416416

417-
Writing Your Own File Codec in Python
417+
Writing your own file codec in Python
418418
=====================================
419419

420420
Python file decoders and encoders should derive from

‎docs/installation.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,27 @@
33
Installation
44
============
55

6-
Basic Installation
6+
Basic installation
77
------------------
88

99
.. Note:: This section has moved to :ref:`basic-installation`. Please update references accordingly.
1010

11-
Python Support
11+
Python support
1212
--------------
1313

1414
.. Note:: This section has moved to :ref:`python-support`. Please update references accordingly.
1515

16-
Platform Support
16+
Platform support
1717
----------------
1818

1919
.. Note:: This section has moved to :ref:`platform-support`. Please update references accordingly.
2020

21-
Building From Source
21+
Building from source
2222
--------------------
2323

2424
.. Note:: This section has moved to :ref:`building-from-source`. Please update references accordingly.
2525

26-
Old Versions
26+
Old versions
2727
------------
2828

2929
.. Note:: This section has moved to :ref:`old-versions`. Please update references accordingly.

‎docs/installation/basic-installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
.. _basic-installation:
1010

11-
Basic Installation
11+
Basic installation
1212
==================
1313

1414
.. note::

‎docs/installation/building-from-source.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88

99
.. _building-from-source:
1010

11-
Building From Source
11+
Building from source
1212
====================
1313

1414
.. _external-libraries:
1515

16-
External Libraries
16+
External libraries
1717
------------------
1818

1919
.. note::
@@ -271,7 +271,7 @@ After navigating to the Pillow directory, run::
271271

272272
.. _compressed archive from PyPI: https://pypi.org/project/pillow/#files
273273

274-
Build Options
274+
Build options
275275
^^^^^^^^^^^^^
276276

277277
* Config setting: ``-C parallel=n``. Can also be given
@@ -319,7 +319,7 @@ Sample usage::
319319

320320
.. _old-versions:
321321

322-
Old Versions
322+
Old versions
323323
============
324324

325325
You can download old distributions from the `release history at PyPI

‎docs/installation/platform-support.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _platform-support:
22

3-
Platform Support
3+
Platform support
44
================
55

66
Current platform support for Pillow. Binary distributions are
@@ -9,7 +9,7 @@ should compile and run everywhere platform support is listed. In
99
general, we aim to support all current versions of Linux, macOS, and
1010
Windows.
1111

12-
Continuous Integration Targets
12+
Continuous integration targets
1313
------------------------------
1414

1515
These platforms are built and tested for every change.
@@ -59,7 +59,7 @@ These platforms are built and tested for every change.
5959
+----------------------------------+----------------------------+---------------------+
6060

6161

62-
Other Platforms
62+
Other platforms
6363
---------------
6464

6565
These platforms have been reported to work at the versions mentioned.

‎docs/installation/python-support.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _python-support:
22

3-
Python Support
3+
Python support
44
==============
55

66
Pillow supports these Python versions.

‎docs/reference/ExifTags.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. py:module:: PIL.ExifTags
22
.. py:currentmodule:: PIL.ExifTags
33
4-
:py:mod:`~PIL.ExifTags` Module
4+
:py:mod:`~PIL.ExifTags` module
55
==============================
66

77
The :py:mod:`~PIL.ExifTags` module exposes several :py:class:`enum.IntEnum`

‎docs/reference/Image.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. py:module:: PIL.Image
22
.. py:currentmodule:: PIL.Image
33
4-
:py:mod:`~PIL.Image` Module
4+
:py:mod:`~PIL.Image` module
55
===========================
66

77
The :py:mod:`~PIL.Image` module provides a class with the same name which is
@@ -113,7 +113,7 @@ Registering plugins
113113
.. autofunction:: register_decoder
114114
.. autofunction:: register_encoder
115115

116-
The Image Class
116+
The Image class
117117
---------------
118118

119119
.. autoclass:: PIL.Image.Image
@@ -261,7 +261,7 @@ method. ::
261261
.. automethod:: PIL.Image.Image.load
262262
.. automethod:: PIL.Image.Image.close
263263

264-
Image Attributes
264+
Image attributes
265265
----------------
266266

267267
Instances of the :py:class:`Image` class have the following attributes:

0 commit comments

Comments
 (0)