show ColorConverter in docstring

adafruit · Nov 7, 2024 · 04bdc7d · 04bdc7d
1 parent 7936be3
commit 04bdc7d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/adafruit_imageload/bmp/__init__.py b/adafruit_imageload/bmp/__init__.py
@@ -35,7 +35,8 @@ def load(
 ) -> Tuple[Optional[Bitmap], Optional[Union[Palette, ColorConverter]]]:
     """Loads a bmp image from the open ``file``.
 
-    Returns tuple of bitmap object and palette object.
+    Returns tuple of `displayio.Bitmap` object and
+    `displayio.Palette` object, or `displayio.ColorConverter` object.
 
     :param io.BufferedReader file: Open file handle or compatible (like `io.BytesIO`)
       with the data of a BMP file.