fix(mosaic): update doc strings

loiccoyle · Jun 24, 2024 · e24e86d · e24e86d
1 parent 41feff5
commit e24e86d
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/phomo/mosaic.py b/phomo/mosaic.py
@@ -38,7 +38,8 @@ def __init__(
 
             >>> pool = Pool.from_dir("tiles")
             >>> master = Master.from_file("master.png")
-            >>> Mosaic(master, pool, n_appearances=1).build()
+            >>> mosaic = Mosaic(master, pool, n_appearances=1)
+            >>> mosaic.build(mosaic.d_matrix())
         """
         self._log = logging.getLogger(__name__)
         self.master = master
@@ -285,6 +286,15 @@ def build(self, d_matrix: np.ndarray) -> Image.Image:
 
         Returns:
             The PIL.Image instance of the mosaic.
+
+        Examples:
+            Building a mosaic.
+
+            >>> mosaic.build(mosaic.d_matrix())
+
+            On a GPU.
+
+            >>> mosaic.build(mosaic.d_matrix_cuda())
         """
         mosaic = np.zeros((self.size[1], self.size[0], 3))