Skip to content

Commit 907cd60

Browse files
committed
Improve summary lines in docs
1 parent b0c6ca9 commit 907cd60

File tree

9 files changed

+130
-109
lines changed

9 files changed

+130
-109
lines changed

doc/source/_templates/autosummary/class.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
.. rubric:: Methods
1313

1414
.. autosummary::
15-
:toctree: _generated
15+
:toctree: .
1616
{% for item in methods %}
1717
~{{ name }}.{{ item }}
1818
{%- endfor %}
@@ -24,7 +24,7 @@
2424
.. rubric:: Attributes
2525

2626
.. autosummary::
27-
:toctree: _generated
27+
:toctree: .
2828
{% for item in attributes %}
2929
~{{ name }}.{{ item }}
3030
{%- endfor %}

docstrings/bitmap.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,13 @@
7575
"""
7676

7777
Bitmap_pitch = """
78-
The pitch's absolute value is the number of bytes taken by one bitmap
79-
row, including padding. However, the pitch is positive when the bitmap
80-
has a ‘down’ flow, and negative when it has an ‘up’ flow. In all
81-
cases, the pitch is an offset to add to a bitmap pointer in order to
82-
go down one row.
78+
The number of bytes taken by one bitmap row.
79+
80+
Includes padding.
81+
82+
The pitch is positive when the bitmap has a ‘down’ flow, and negative
83+
when it has an ‘up’ flow. In all cases, the pitch is an offset to add
84+
to a bitmap pointer in order to go down one row.
8385
8486
Note that ‘padding’ means the alignment of a bitmap to a byte border,
8587
and FreeType functions normally align to the smallest possible integer

docstrings/charmap.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
"""
6868

6969
CharMap_get_format = """
70-
Return TrueType/sfnt specific cmap format.
70+
Get the TrueType/sfnt specific cmap format.
7171
7272
Returns
7373
-------
@@ -77,7 +77,7 @@
7777
"""
7878

7979
CharMap_get_language_id = """
80-
Return TrueType/sfnt specific cmap language ID.
80+
Get the TrueType/sfnt specific cmap language ID.
8181
8282
It will be one of the constants in `TT_MAC_LANGID` or `TT_MS_LANGID`.
8383

0 commit comments

Comments
 (0)