Add example to 'find_objects' function docstring

Zulko · Jun 1, 2021 · f010297 · f010297
1 parent 9cd0127
commit f010297
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/moviepy/video/tools/segmenting.py b/moviepy/video/tools/segmenting.py
@@ -22,6 +22,16 @@ def find_objects(clip, size_threshold=500, preview=False):
     preview : bool, optional
       Previews with matplotlib the different objects found in the image before
       applying the size threshold. Requires matplotlib installed.
+
+
+    Examples
+    --------
+
+    >>> clip = ImageClip("media/afterimage.png")
+    >>> objects = find_objects(clip)
+    >>>
+    >>> print(len(objects))
+    >>> print([obj_.screenpos for obj_ in objects])
     """
     image = clip.get_frame(0)
     if not clip.mask:  # pragma: no cover