Skip to content

Commit a7ccf0a

Browse files
committed
Address review comments
halfdelay() now says that getkey() and get_wch() raise while getch() returns -1; termname() describes the name of the terminal in use rather than TERM alone, and keeps the 14-character note as a library-dependent caveat; the touched paragraphs use semantic line breaks so that no line is reflowed needlessly.
1 parent 7e1ab2f commit a7ccf0a

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

Doc/library/curses.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -274,9 +274,11 @@ Input options
274274

275275
Used for half-delay mode, which is similar to cbreak mode in that characters
276276
typed by the user are immediately available to the program. However, after
277-
blocking for *tenths* tenths of seconds, :meth:`~window.getch` returns ``-1``
278-
if nothing has been typed. The value of *tenths* must be a number between
279-
``1`` and ``255``. Use :func:`nocbreak` to leave half-delay mode.
277+
blocking for *tenths* tenths of seconds, if nothing has been typed,
278+
:meth:`~window.getch` returns ``-1``, while :meth:`~window.getkey` and
279+
:meth:`~window.get_wch` raise :exc:`curses.error`.
280+
The value of *tenths* must be a number between ``1`` and ``255``.
281+
Use :func:`nocbreak` to leave half-delay mode.
280282

281283
.. function:: meta(flag)
282284

@@ -891,8 +893,10 @@ Querying the terminal
891893

892894
.. function:: termname()
893895

894-
Return the value of the environment variable :envvar:`TERM`, as a bytes
895-
object.
896+
Return the name of the terminal in use, as a bytes object.
897+
This is the name passed to :func:`initscr`, :func:`newterm` or
898+
:func:`setupterm`, or the value of the :envvar:`TERM` environment variable
899+
if none was given. Some curses libraries truncate it to 14 characters.
896900

897901
.. function:: longname()
898902

@@ -1215,8 +1219,8 @@ Adding and inserting text
12151219
Insert character *ch* with attributes *attr* before the character under the
12161220
cursor, or at ``(y, x)`` if specified. All characters to the right of the
12171221
cursor are shifted one position right, with the rightmost character on the
1218-
line being lost. The cursor position does not change (after moving to *y*,
1219-
*x*, if specified).
1222+
line being lost.
1223+
The cursor position does not change (after moving to *y*, *x*, if specified).
12201224

12211225
.. versionchanged:: next
12221226
Wide and combining characters, and :class:`complexchar` cells, are now
@@ -1241,8 +1245,8 @@ Adding and inserting text
12411245

12421246
Insert a character string (as many characters as will fit on the line) before
12431247
the character under the cursor, up to *n* characters. If *n* is negative,
1244-
the entire string is inserted. All characters to the right of the cursor are
1245-
shifted right, with the rightmost characters on the line being lost.
1248+
the entire string is inserted. All characters to the right of the
1249+
cursor are shifted right, with the rightmost characters on the line being lost.
12461250
The cursor position does not change (after moving to *y*, *x*, if specified).
12471251

12481252
.. versionchanged:: next
@@ -1860,9 +1864,9 @@ Output options
18601864
.. method:: window.scroll([lines=1])
18611865

18621866
Scroll the screen or scrolling region. Scroll upward by *lines* lines if
1863-
*lines* is positive, or downward if it is negative. Raise
1864-
:exc:`curses.error` unless scrolling has been enabled for the window with
1865-
:meth:`scrollok`.
1867+
*lines* is positive, or downward if it is negative.
1868+
Raise :exc:`curses.error` unless scrolling has been enabled for the window
1869+
with :meth:`scrollok`.
18661870

18671871
.. method:: window.setscrreg(top, bottom)
18681872

0 commit comments

Comments
 (0)