Document replacements for individual deprecated font methods

This commit is contained in:
nulano 2022-06-30 15:02:09 +02:00
parent 65020e7c7c
commit ad5271d62f
No known key found for this signature in database
GPG Key ID: B650CDF63B705766
2 changed files with 11 additions and 8 deletions

View File

@ -437,13 +437,12 @@ Methods
.. py:method:: ImageDraw.textsize(text, font=None, spacing=4, direction=None, features=None, language=None, stroke_width=0) .. py:method:: ImageDraw.textsize(text, font=None, spacing=4, direction=None, features=None, language=None, stroke_width=0)
.. deprecated:: 9.2.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. 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 .. note:: For historical reasons this function measures text height from
the ascender line instead of the top, see :ref:`text-anchors`. the ascender line instead of the top, see :ref:`text-anchors`.
If you wish to measure text height from the top, it is recommended If you wish to measure text height from the top, it is recommended
@ -487,6 +486,7 @@ Methods
.. py:method:: ImageDraw.multiline_textsize(text, font=None, spacing=4, direction=None, features=None, language=None, stroke_width=0) .. py:method:: ImageDraw.multiline_textsize(text, font=None, spacing=4, direction=None, features=None, language=None, stroke_width=0)
.. deprecated:: 9.2.0 .. deprecated:: 9.2.0
Use :py:meth:`.multiline_textbbox` instead.
Return the size of the given string, in pixels. Return the size of the given string, in pixels.

View File

@ -138,6 +138,7 @@ class ImageFont:
def getsize(self, text, *args, **kwargs): def getsize(self, text, *args, **kwargs):
""" """
.. deprecated:: 9.2.0 .. deprecated:: 9.2.0
Use :py:meth:`.getbbox` or :py:meth:`.getlength` instead.
Returns width and height (in pixels) of given text. Returns width and height (in pixels) of given text.
@ -427,14 +428,13 @@ class FreeTypeFont:
): ):
""" """
.. deprecated:: 9.2.0 .. 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 Returns width and height (in pixels) of given text if rendered in font with
provided direction, features, and language. 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 .. note:: For historical reasons this function measures text height from
the ascender line instead of the top, see :ref:`text-anchors`. the ascender line instead of the top, see :ref:`text-anchors`.
If you wish to measure text height from the top, it is recommended If you wish to measure text height from the top, it is recommended
@ -498,6 +498,7 @@ class FreeTypeFont:
): ):
""" """
.. deprecated:: 9.2.0 .. deprecated:: 9.2.0
Use :py:meth:`.ImageDraw.multiline_textbbox` instead.
Returns width and height (in pixels) of given text if rendered in font Returns width and height (in pixels) of given text if rendered in font
with provided direction, features, and language, while respecting with provided direction, features, and language, while respecting
@ -555,6 +556,7 @@ class FreeTypeFont:
def getoffset(self, text): def getoffset(self, text):
""" """
.. deprecated:: 9.2.0 .. deprecated:: 9.2.0
Use :py:meth:`.getbbox` instead.
Returns the offset of given text. This is the gap between the Returns the offset of given text. This is the gap between the
starting coordinate and the first marking. Note that this gap is starting coordinate and the first marking. Note that this gap is
@ -847,6 +849,7 @@ class TransposedFont:
def getsize(self, text, *args, **kwargs): def getsize(self, text, *args, **kwargs):
""" """
.. deprecated:: 9.2.0 .. deprecated:: 9.2.0
Use :py:meth:`.getbbox` or :py:meth:`.getlength` instead.
""" """
if not kwargs.get("__internal__"): if not kwargs.get("__internal__"):
deprecate("getsize", 10, "getbbox or getlength") deprecate("getsize", 10, "getbbox or getlength")