Merge pull request #7305 from hugovk/docs-clarify-textlength-return

Docs: Clarify that a single value is returned, and depends on the text direction
python-pillow · Jul 25, 2023 · 07623d1 · 07623d1
2 parents 3c5324b + 62cd236
commit 07623d1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/reference/ImageDraw.rst b/docs/reference/ImageDraw.rst
@@ -538,7 +538,7 @@ Methods
                      It should be a `BCP 47 language code`_.
                      Requires libraqm.
     :param embedded_color: Whether to use font embedded color glyphs (COLR, CBDT, SBIX).
-    :return: Width for horizontal, height for vertical text.
+    :return: Either width for horizontal text, or height for vertical 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)
 

diff --git a/src/PIL/ImageFont.py b/src/PIL/ImageFont.py
@@ -318,7 +318,7 @@ def getlength(self, text, mode="", direction=None, features=None, language=None)
                          <https://www.w3.org/International/articles/language-tags/>`_
                          Requires libraqm.
 
-        :return: Width for horizontal, height for vertical text.
+        :return: Either width for horizontal text, or height for vertical text.
         """
         _string_length_check(text)
         return self.font.getlength(text, mode, direction, features, language) / 64