[3.14] gh-87881: Document the result of curses inch() and getbkgd() (GH-152488) ...

Explain the character/attribute bit layout and how to extract the parts
(A_CHARTEXT and A_ATTRIBUTES bit-masks, pair_number() for the color pair).
(cherry picked from commit d831a690766e92b3be5e40134f64407bd041bcbf)
(cherry picked from commit 09013312bbdf9ff6583c95ba6bc2698e61c66be6)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst
index 3d037ea7b455945fc4e781771c871ae5807bca7e..b74dfa04710740624b73a780f26467fdd90adb33 100644 (file)
--- a/Doc/library/curses.rst
+++ b/Doc/library/curses.rst
@@ -978,6 +978,7 @@ Window objects
 .. method:: window.getbkgd()
 
    Return the given window's current background character/attribute pair.
+   Its components can be extracted like those of :meth:`inch`.
 
 
 .. method:: window.getch([y, x])
@@ -1068,8 +1069,10 @@ Window objects
 
 .. method:: window.inch([y, x])
 
-   Return the character at the given position in the window. The bottom 8 bits are
-   the character proper, and upper bits are the attributes.
+   Return the character at the given position in the window.
+   The bottom 8 bits are the character proper and the upper bits are the attributes;
+   extract them with the :data:`A_CHARTEXT` and :data:`A_ATTRIBUTES` bit-masks,
+   and the color pair with :func:`pair_number`.
 
 
 .. method:: window.insch(ch[, attr])