Skip to content

Commit 015cc42

Browse files
[3.14] gh-151623: Improve curses documentation and docstrings (GH-151625) (GH-151629)
Fix errors and clarify the curses, curses.panel and curses.ascii docs against X/Open Curses and ncurses, and sync the affected docstrings. (cherry picked from commit 65afcdd)
1 parent 7202313 commit 015cc42

8 files changed

Lines changed: 132 additions & 70 deletions

File tree

Doc/library/curses.ascii.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ C library:
117117

118118
.. function:: isblank(c)
119119

120-
Checks for an ASCII whitespace character; space or horizontal tab.
120+
Checks for an ASCII blank character; space or horizontal tab.
121121

122122

123123
.. function:: iscntrl(c)
@@ -171,7 +171,8 @@ C library:
171171

172172
.. function:: isctrl(c)
173173

174-
Checks for an ASCII control character (ordinal values 0 to 31).
174+
Checks for an ASCII control character (ordinal values 0 to 31). Unlike
175+
:func:`iscntrl`, this does not include the delete character (0x7f).
175176

176177

177178
.. function:: ismeta(c)

Doc/library/curses.panel.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ The module :mod:`!curses.panel` defines the following functions:
2828

2929
.. function:: new_panel(win)
3030

31-
Returns a panel object, associating it with the given window *win*. Be aware
31+
Returns a panel object, associating it with the given window *win* and
32+
placing the new panel on top of the panel stack. Be aware
3233
that you need to keep the returned panel object referenced explicitly. If you
3334
don't, the panel object is garbage collected and removed from the panel stack.
3435

@@ -101,7 +102,8 @@ Panel objects have the following methods:
101102

102103
.. method:: Panel.show()
103104

104-
Display the panel (which might have been hidden).
105+
Display the panel (which might have been hidden), placing it on top of
106+
the panel stack.
105107

106108

107109
.. method:: Panel.top()

0 commit comments

Comments
 (0)