[3.15] gh-156347: Fix wrong statements in the curses documentation (GH-156354) - #156872
Merged
Merged
Conversation
…ion (pythonGH-156354) window.encoding does not encode the string arguments on a build with wide-character support: the curses library converts the characters itself. In the HOWTO: getch() returns -1, not curses.ERR, when there is no input, and half-delay mode does the same as no-delay mode. getkey() returns the key name only for a special key. leaveok() is not a synonym for curs_set(). getstr() returns a bytes object, interprets the erase and kill characters, and limits bytes. The ACS_* constants are not all larger than 255. Also document get_wch() before getch(), and read whole characters in the example. (cherry picked from commit 161054c)
bedevere-app
Bot
added
docs
Documentation build overview
128 files changed ·
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Manual backport of #156354.
window.encodingdoes not encode the string arguments on a build with wide-character support: the curses library converts the characters itself.In the HOWTO:
getch()returns -1, notcurses.ERR, when there is no input, and half-delay mode does the same as no-delay mode.getkey()returns the key name only for a special key.leaveok()is not a synonym forcurs_set().getstr()returns a bytes object, interprets the erase and kill characters, and limits bytes. TheACS_*constants are not all larger than 255. Also documentget_wch()beforegetch(), and read whole characters in the example.The mentions of
complexchar,complexstr,in_wch(),in_wchstr()andget_wstr()are omitted: these do not exist in 3.15.(cherry picked from commit 161054c)
window.encodingdoes not encodestrarguments on a wide build #156347