mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-13 15:40:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-107008: Document the curses module variables LINES and COLS (GH-107011)

Browse source 
LINES and COLS referred in curses.update_lines_cols() documentations are
the module variables, not the environment variables.
This commit is contained in:
Serhiy Storchaka 2023-07-22 19:54:50 +03:00 • committed by GitHub
parent 6fbc717214
commit 26e08dfdd7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Doc/library/curses.rst
View file

@ -641,7 +641,8 @@ The module :mod:`curses` defines the following functions:
.. function:: update_lines_cols() .. 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 .. versionadded:: 3.5
@ -1342,10 +1343,27 @@ The :mod:`curses` module defines the following data members:
.. data:: COLORS .. data:: COLORS
The maximum number of colors the terminal can support. The maximum number of colors the terminal can support.
It is defined only after the call to :func:`start_color`.
.. data:: COLOR_PAIRS .. data:: COLOR_PAIRS
The maximum number of color pairs the terminal can support. 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. Some constants are available to specify character cell attributes.
The exact constants available are system dependent. The exact constants available are system dependent.

4
Doc/whatsnew/3.5.rst
View file

@ -1045,8 +1045,8 @@ not just sequences. (Contributed by Serhiy Storchaka in :issue:`23171`.)
curses curses
------ ------
The new :func:`~curses.update_lines_cols` function updates the :envvar:`LINES` The new :func:`~curses.update_lines_cols` function updates the :data:`LINES`
and :envvar:`COLS` environment variables. This is useful for detecting and :data:`COLS` module variables. This is useful for detecting
manual screen resizing. (Contributed by Arnon Yaari in :issue:`4254`.) manual screen resizing. (Contributed by Arnon Yaari in :issue:`4254`.)

2
Misc/NEWS.d/next/Documentation/2023-07-22-15-14-13.gh-issue-107008.3JQ1Vt.rst Normal file
View file

@ -0,0 +1,2 @@
Document the :mod:`curses` module variables :const:`~curses.LINES` and
:const:`~curses.COLS`.