Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Document a workaround for a curses bug (GH-13209)

This commit is contained in:
Toshio Kuratomi 2019-05-17 18:54:02 -04:00 committed by Lisa Roach
parent 51a860ee01
commit e7b1136ec3
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Doc/library/curses.rst
View File

@ -708,9 +708,16 @@ the following methods and attributes:
.. note::
Writing outside the window, subwindow, or pad raises :exc:`curses.error`.
Attempting to write to the lower right corner of a window, subwindow,
or pad will cause an exception to be raised after the string is printed.
* Writing outside the window, subwindow, or pad raises :exc:`curses.error`.
Attempting to write to the lower right corner of a window, subwindow,
or pad will cause an exception to be raised after the string is printed.
* A `bug in ncurses <https://bugs.python.org/issue35924>`_, the backend
for this Python module, can cause SegFaults when resizing windows. This
is fixed in ncurses-6.1-20190511. If you are stuck with an earlier
ncurses, you can avoid triggering this if you do not call :func:`addstr`
with a *str* that has embedded newlines. Instead, call :func:`addstr`
separately for each line.
.. method:: window.attroff(attr)

2
Misc/NEWS.d/next/Documentation/2019-05-08-13-17-44.bpo-35924.lqbNpW.rst Normal file
View File

@ -0,0 +1,2 @@
Add a note to the ``curses.addstr()`` documentation to warn that multiline
strings can cause segfaults because of an ncurses bug.