Skip to content

gh-87881: Document the result of curses inch() and getbkgd() #152488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
serhiy-storchaka merged 1 commit into from
Jun 28, 2026
Merged

gh-87881: Document the result of curses inch() and getbkgd() #152488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions Doc/library/curses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1332,6 +1332,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`.
It cannot represent a background set with a wide character or with a color
pair outside the :func:`color_pair` range; use :meth:`getbkgrnd` for those.

Expand Down Expand Up @@ -1486,11 +1487,13 @@ 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`.
It cannot represent a cell holding combining characters, a character that does
not fit in a single byte, or a color pair outside the :func:`color_pair`
range; use :meth:`in_wch` for those.
range; use :meth:`in_wch` for those, which returns it as a :class:`complexchar`.


.. method:: window.in_wch([y, x])
Expand Down
Loading