python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-01-13 02:36:17 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improved documentation of return values

Browse Source
This commit is contained in:
Andrew Murray 2022-09-01 22:26:35 +10:00
parent 3f960d9a94
commit 7966c344ac
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/reference/ImageDraw.rst
View File

@ -489,6 +489,8 @@ Methods
.. versionadded:: 6.2.0 .. versionadded:: 6.2.0
:returns: A ``(width, height)`` tuple.
.. 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
@ -541,6 +543,8 @@ Methods
.. versionadded:: 6.2.0 .. versionadded:: 6.2.0
:returns: A ``(width, height)`` tuple.
.. py:method:: ImageDraw.textlength(text, font=None, direction=None, features=None, language=None, embedded_color=False) .. py:method:: ImageDraw.textlength(text, font=None, direction=None, features=None, language=None, embedded_color=False)
Returns length (in pixels with 1/64 precision) of given text when rendered Returns length (in pixels with 1/64 precision) of given text when rendered
@ -608,6 +612,7 @@ Methods
It should be a `BCP 47 language code`_. It should be a `BCP 47 language code`_.
Requires libraqm. Requires libraqm.
:param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX). :param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX).
:returns: A single float, the length of the text.
.. py:method:: ImageDraw.textbbox(xy, text, font=None, anchor=None, spacing=4, align="left", direction=None, features=None, language=None, stroke_width=0, embedded_color=False) .. py:method:: ImageDraw.textbbox(xy, text, font=None, anchor=None, spacing=4, align="left", direction=None, features=None, language=None, stroke_width=0, embedded_color=False)
@ -657,6 +662,8 @@ Methods
Requires libraqm. Requires libraqm.
:param stroke_width: The width of the text stroke. :param stroke_width: The width of the text stroke.
:param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX). :param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX).
:returns: An ``(x0, y0, x1, y1)`` tuple, describing the top left and lower right
corners of the text.
.. py:method:: ImageDraw.multiline_textbbox(xy, text, font=None, anchor=None, spacing=4, align="left", direction=None, features=None, language=None, stroke_width=0, embedded_color=False) .. py:method:: ImageDraw.multiline_textbbox(xy, text, font=None, anchor=None, spacing=4, align="left", direction=None, features=None, language=None, stroke_width=0, embedded_color=False)
@ -700,6 +707,8 @@ Methods
Requires libraqm. Requires libraqm.
:param stroke_width: The width of the text stroke. :param stroke_width: The width of the text stroke.
:param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX). :param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX).
:returns: An ``(x0, y0, x1, y1)`` tuple, describing the top left and lower right
corners of the text.
.. py:method:: getdraw(im=None, hints=None) .. py:method:: getdraw(im=None, hints=None)