Skip to content

gh-138071: Clarify curses.color_pair doc about style vs extraction masks #138079

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

Closed
wants to merge 1 commit into from
Closed

gh-138071: Clarify curses.color_pair doc about style vs extraction masks #138079

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
13 changes: 9 additions & 4 deletions Doc/library/curses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,15 @@ The module :mod:`curses` defines the following functions:
.. function:: color_pair(pair_number)

Return the attribute value for displaying text in the specified color pair.
Only the first 256 color pairs are supported. This
attribute value can be combined with :const:`A_STANDOUT`, :const:`A_REVERSE`,
and the other :const:`!A_\*` attributes. :func:`pair_number` is the counterpart
to this function.
Only the first 256 color pairs are supported. The value returned by
``color_pair(n)`` is an attribute mask. It can be combined (using bitwise OR, ``|``)
with other style attributes such as :const:`A_BOLD`, :const:`A_REVERSE`,
:const:`A_UNDERLINE`, etc. Note that :const:`A_COLOR`, :const:`A_ATTRIBUTES`,
and :const:`A_CHARTEXT` are extraction masks used with bitwise AND (``&``) on
values returned from functions like :meth:`window.inch`. They are not style
attributes and must not be combined with :func:`color_pair`. :func:`pair_number`
is the counterpart to this function.



.. function:: curs_set(visibility)
Expand Down
Loading