Skip to content

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

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

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

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
7 changes: 5 additions & 2 deletions Doc/library/curses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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])
Expand Down Expand Up @@ -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])
Expand Down
Loading