Added documentation

Author: radarhere

docs/releasenotes/12.1.0.rst

@@ -41,6 +41,31 @@ TODO
 API additions
 =============
 
+ImageText.Text.wrap
+^^^^^^^^^^^^^^^^^^^
+
+:py:meth:`.ImageText.Text.wrap` has been added, to wrap text to fit within a given
+width::
+
+    from PIL import ImageText
+    text = ImageText.Text("Hello World!")
+    text.wrap(50)
+    print(text.text)  # "Hello\nWorld!"
+
+or within a certain width and height, returning a new :py:class:`.ImageText.Text`
+instance if the text does not fit::
+
+    text = ImageText.Text("Text does not fit within height")
+    print(text.wrap(50, 25).text == " within height")
+    print(text.text)  # "Text does\nnot fit"
+
+or scaling, optionally with a font size limit::
+
+    text.wrap(50, 15, "shrink")
+    text.wrap(50, 15, ("shrink", 7))
+    text.wrap(58, 10, "grow")
+    text.wrap(50, 50, ("grow", 12))
+
 Specify window in ImageGrab on macOS
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

src/PIL/ImageText.py

@@ -178,6 +178,19 @@ def wrap(
         height: int | None = None,
         scaling: str | tuple[str, int] | None = None,
     ) -> Text[AnyStr] | None:
+        """
+        Wrap text to fit within a given width.
+
+        :param width: The width to fit within.
+        :param height: An optional height limit. Any text that does not fit within this
+                       will be returned as a new :py:class:`.Text` object.
+        :param scaling: An optional directive to scale the text, either "grow" as much
+                        as possible within the given dimensions, or "shrink" until it
+                        fits. It can also be a tuple of (direction, limit), with an
+                        integer limit to stop scaling at.
+
+        :returns: An :py:class:`.Text` object, or None.
+        """
         if isinstance(self.font, ImageFont.TransposedFont):
             msg = "TransposedFont not supported"
             raise ValueError(msg)