Added _SupportsGetMesh to docs

python-pillow · Feb 19, 2024 · c24c771 · c24c771
1 parent e1c5d57
commit c24c771
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/reference/ImageOps.rst b/docs/reference/ImageOps.rst
@@ -14,6 +14,7 @@ only work on L and RGB images.
 .. autofunction:: colorize
 .. autofunction:: crop
 .. autofunction:: scale
+.. autoclass:: _SupportsGetMesh
 .. autofunction:: deform
 .. autofunction:: equalize
 .. autofunction:: expand

diff --git a/src/PIL/ImageOps.py b/src/PIL/ImageOps.py
@@ -412,6 +412,14 @@ def scale(
 
 
 class _SupportsGetMesh(Protocol):
+    """
+    An object that supports the ``getmesh`` method, taking an image as an
+    argument, and returning a list of tuples. Each tuple contains two tuples,
+    the source box as a tuple of 4 integers, and a tuple of 8 integers for the
+    final quadrilateral, in order of top left, bottom left, bottom right, top
+    right.
+    """
+
     def getmesh(
         self, image: Image.Image
     ) -> list[