Skip to content

Commit

Permalink
Document replacements for individual deprecated font methods
Browse files Browse the repository at this point in the history
  • Loading branch information
nulano committed Jun 30, 2022
1 parent 65020e7 commit ad5271d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/reference/ImageDraw.rst
Expand Up @@ -437,13 +437,12 @@ Methods
.. py:method:: ImageDraw.textsize(text, font=None, spacing=4, direction=None, features=None, language=None, stroke_width=0)
.. deprecated:: 9.2.0
Use :py:meth:`textlength()` to measure the offset of following text with
1/64 pixel precision.
Use :py:meth:`textbbox()` to get the exact bounding box based on an anchor.

Return the size of the given string, in pixels.

Use :py:meth:`textlength()` to measure the offset of following text with
1/64 pixel precision.
Use :py:meth:`textbbox()` to get the exact bounding box based on an anchor.

.. note:: For historical reasons this function measures text height from
the ascender line instead of the top, see :ref:`text-anchors`.
If you wish to measure text height from the top, it is recommended
Expand Down Expand Up @@ -487,6 +486,7 @@ Methods
.. py:method:: ImageDraw.multiline_textsize(text, font=None, spacing=4, direction=None, features=None, language=None, stroke_width=0)
.. deprecated:: 9.2.0
Use :py:meth:`.multiline_textbbox` instead.

Return the size of the given string, in pixels.

Expand Down
11 changes: 7 additions & 4 deletions src/PIL/ImageFont.py
Expand Up @@ -138,6 +138,7 @@ def _load_pilfont_data(self, file, image):
def getsize(self, text, *args, **kwargs):
"""
.. deprecated:: 9.2.0
Use :py:meth:`.getbbox` or :py:meth:`.getlength` instead.
Returns width and height (in pixels) of given text.
Expand Down Expand Up @@ -427,14 +428,13 @@ def getsize(
):
"""
.. deprecated:: 9.2.0
Use :py:meth:`getlength()` to measure the offset of following text with
1/64 pixel precision.
Use :py:meth:`getbbox()` to get the exact bounding box based on an anchor.
Returns width and height (in pixels) of given text if rendered in font with
provided direction, features, and language.
Use :py:meth:`getlength()` to measure the offset of following text with
1/64 pixel precision.
Use :py:meth:`getbbox()` to get the exact bounding box based on an anchor.
.. note:: For historical reasons this function measures text height from
the ascender line instead of the top, see :ref:`text-anchors`.
If you wish to measure text height from the top, it is recommended
Expand Down Expand Up @@ -498,6 +498,7 @@ def getsize_multiline(
):
"""
.. deprecated:: 9.2.0
Use :py:meth:`.ImageDraw.multiline_textbbox` instead.
Returns width and height (in pixels) of given text if rendered in font
with provided direction, features, and language, while respecting
Expand Down Expand Up @@ -555,6 +556,7 @@ def getsize_multiline(
def getoffset(self, text):
"""
.. deprecated:: 9.2.0
Use :py:meth:`.getbbox` instead.
Returns the offset of given text. This is the gap between the
starting coordinate and the first marking. Note that this gap is
Expand Down Expand Up @@ -847,6 +849,7 @@ def __init__(self, font, orientation=None):
def getsize(self, text, *args, **kwargs):
"""
.. deprecated:: 9.2.0
Use :py:meth:`.getbbox` or :py:meth:`.getlength` instead.
"""
if not kwargs.get("__internal__"):
deprecate("getsize", 10, "getbbox or getlength")
Expand Down

0 comments on commit ad5271d

Please sign in to comment.