Skip to content

gh-107008: Document the curses module variables LINES and COLS #107011

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
merged 1 commit into from
Jul 22, 2023
Merged

gh-107008: Document the curses module variables LINES and COLS #107011

Show file tree
Hide file tree
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
20 changes: 19 additions & 1 deletion Doc/library/curses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,8 @@ The module :mod:`curses` defines the following functions:

.. function:: update_lines_cols()

Update :envvar:`LINES` and :envvar:`COLS`. Useful for detecting manual screen resize.
Update the :const:`LINES` and :const:`COLS` module variables.
Useful for detecting manual screen resize.

.. versionadded:: 3.5

Expand Down Expand Up @@ -1342,10 +1343,27 @@ The :mod:`curses` module defines the following data members:
.. data:: COLORS

The maximum number of colors the terminal can support.
It is defined only after the call to :func:`start_color`.

.. data:: COLOR_PAIRS

The maximum number of color pairs the terminal can support.
It is defined only after the call to :func:`start_color`.

.. data:: COLS

The width of the screen, i.e., the number of columns.
It is defined only after the call to :func:`initscr`.
Updated by :func:`update_lines_cols`, :func:`resizeterm` and
:func:`resize_term`.

.. data:: LINES

The height of the screen, i.e., the number of lines.
It is defined only after the call to :func:`initscr`.
Updated by :func:`update_lines_cols`, :func:`resizeterm` and
:func:`resize_term`.


Some constants are available to specify character cell attributes.
The exact constants available are system dependent.
Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.5.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1045,8 +1045,8 @@ not just sequences. (Contributed by Serhiy Storchaka in :issue:`23171`.)
curses
------

The new :func:`~curses.update_lines_cols` function updates the :envvar:`LINES`
and :envvar:`COLS` environment variables. This is useful for detecting
The new :func:`~curses.update_lines_cols` function updates the :data:`LINES`
and :data:`COLS` module variables. This is useful for detecting
manual screen resizing. (Contributed by Arnon Yaari in :issue:`4254`.)


Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2023-07-22-15-14-13.gh-issue-107008.3JQ1Vt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document the :mod:`curses` module variables :const:`~curses.LINES` and
:const:`~curses.COLS`.