docs/library/framebuf: Clarify docs for blit regarding palette.

Clarified the behaviour when both key and palette are specified.
micropython · Nov 17, 2022 · 859d0e9 · 859d0e9
1 parent 4ff10b5
commit 859d0e9
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/library/framebuf.rst b/docs/library/framebuf.rst
@@ -133,7 +133,9 @@ Other methods
     Draw another FrameBuffer on top of the current one at the given coordinates.
     If *key* is specified then it should be a color integer and the
     corresponding color will be considered transparent: all pixels with that
-    color value will not be drawn.
+    color value will not be drawn. (If the *palette* is specified then the *key*
+    is compared to the value from *palette*, not to the value directly from
+    *fbuf*.)
 
     The *palette* argument enables blitting between FrameBuffers with differing
     formats. Typical usage is to render a monochrome or grayscale glyph/icon to