bpo-35924: Document a workaround for a curses bug #13209
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The ncurses library has a bug which can provoke a segfault when a window
is resized. The bug is provoked when a string with embedded newlines is
added via addstr(). This commit documents that problem in the curses
python library documentation and relates how to workaround the problem
in the calling code.
It will likely be years before every vendor upgrades their ncurses library even once upstream fixes the bug so it seems like a good idea to document the issue and a workaround.
Related to https://bugs.python.org/issue35924
Note that merging this change should not close the bug report as it only documents a workaround.
https://bugs.python.org/issue35924