Skip to content

Commit 9e31ca8

Browse files
hugovkmiss-islington
authored andcommitted
gh-151623: Improve curses documentation style (GH-151635)
(cherry picked from commit f551705) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 015cc42 commit 9e31ca8

2 files changed

Lines changed: 26 additions & 26 deletions

File tree

Doc/library/curses.panel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The module :mod:`!curses.panel` defines the following functions:
4747

4848
.. _curses-panel-objects:
4949

50-
Panel Objects
50+
Panel objects
5151
-------------
5252

5353
Panel objects, as returned by :func:`new_panel` above, are windows with a

Doc/library/curses.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ The module :mod:`!curses` defines the following functions:
246246

247247
.. function:: getwin(file)
248248

249-
Read window related data stored in the file by an earlier :meth:`window.putwin` call.
249+
Read window-related data stored in the file by an earlier :meth:`window.putwin` call.
250250
The routine then creates and initializes a new window using that data, returning
251251
the new window object. The *file* argument must be a file object opened for
252252
reading in binary mode.
@@ -260,7 +260,7 @@ The module :mod:`!curses` defines the following functions:
260260

261261
Return ``True`` if the module supports extended colors; otherwise, return
262262
``False``. Extended color support allows more than 256 color pairs for
263-
terminals that support more than 16 colors (e.g. xterm-256color).
263+
terminals that support more than 16 colors (for example, xterm-256color).
264264

265265
Extended color support requires ncurses version 6.1 or later.
266266

@@ -412,7 +412,7 @@ The module :mod:`!curses` defines the following functions:
412412
methods of a pad require 6 arguments to specify the part of the pad to be
413413
displayed and the location on the screen to be used for the display. The
414414
arguments are *pminrow*, *pmincol*, *sminrow*, *smincol*, *smaxrow*, *smaxcol*; the *p*
415-
arguments refer to the upper left corner of the pad region to be displayed and
415+
arguments refer to the upper-left corner of the pad region to be displayed and
416416
the *s* arguments define a clipping box on the screen within which the pad region
417417
is to be displayed.
418418

@@ -649,7 +649,7 @@ The module :mod:`!curses` defines the following functions:
649649
.. function:: tparm(str[, ...])
650650

651651
Instantiate the bytes object *str* with the supplied parameters, where *str* should
652-
be a parameterized string obtained from the terminfo database. E.g.
652+
be a parameterized string obtained from the terminfo database. For example,
653653
``tparm(tigetstr("cup"), 5, 3)`` could result in ``b'\033[6;4H'``, the exact
654654
result depending on terminal type. Up to nine integer parameters may be supplied.
655655

@@ -739,7 +739,7 @@ The module :mod:`!curses` defines the following functions:
739739

740740
.. _curses-window-objects:
741741

742-
Window Objects
742+
Window objects
743743
--------------
744744

745745
.. class:: window
@@ -758,7 +758,7 @@ Window Objects
758758
.. note::
759759

760760
Writing outside the window, subwindow, or pad raises a :exc:`curses.error`.
761-
Attempting to write to the lower right corner of a window, subwindow,
761+
Attempting to write to the lower-right corner of a window, subwindow,
762762
or pad will cause an exception to be raised after the character is printed.
763763

764764

@@ -779,7 +779,7 @@ Window Objects
779779
.. note::
780780

781781
* Writing outside the window, subwindow, or pad raises :exc:`curses.error`.
782-
Attempting to write to the lower right corner of a window, subwindow,
782+
Attempting to write to the lower-right corner of a window, subwindow,
783783
or pad will cause an exception to be raised after the string is printed.
784784

785785
* A bug in ncurses, the backend for this Python module, could cause
@@ -1016,8 +1016,8 @@ Window Objects
10161016
window.getstr(y, x, n)
10171017

10181018
Read a bytes object from the user, with primitive line editing capacity.
1019-
At most *n* characters are read (2047 by default).
1020-
The maximum value for *n* is 2047.
1019+
At most *n* characters are read;
1020+
*n* defaults to and cannot exceed 2047.
10211021

10221022
.. versionchanged:: 3.14
10231023
The maximum value for *n* was increased from 1023 to 2047.
@@ -1246,10 +1246,10 @@ Window Objects
12461246

12471247
The 6 arguments can only be specified, and are then required, when the window
12481248
is a pad created with :func:`newpad`. The additional parameters are needed to indicate what part
1249-
of the pad and screen are involved. *pminrow* and *pmincol* specify the upper
1250-
left-hand corner of the rectangle to be displayed in the pad. *sminrow*,
1249+
of the pad and screen are involved. *pminrow* and *pmincol* specify the
1250+
upper-left corner of the rectangle to be displayed in the pad. *sminrow*,
12511251
*smincol*, *smaxrow*, and *smaxcol* specify the edges of the rectangle to be
1252-
displayed on the screen. The lower right-hand corner of the rectangle to be
1252+
displayed on the screen. The lower-right corner of the rectangle to be
12531253
displayed in the pad is calculated from the screen coordinates, since the
12541254
rectangles must be the same size. Both rectangles must be entirely contained
12551255
within their respective structures. Negative values of *pminrow*, *pmincol*,
@@ -1418,14 +1418,14 @@ The :mod:`!curses` module defines the following data members:
14181418

14191419
.. data:: COLS
14201420

1421-
The width of the screen, i.e., the number of columns.
1421+
The width of the screen, that is, the number of columns.
14221422
It is defined only after the call to :func:`initscr`.
14231423
Updated by :func:`update_lines_cols`, :func:`resizeterm` and
14241424
:func:`resize_term`.
14251425

14261426
.. data:: LINES
14271427

1428-
The height of the screen, i.e., the number of lines.
1428+
The height of the screen, that is, the number of lines.
14291429
It is defined only after the call to :func:`initscr`.
14301430
Updated by :func:`update_lines_cols`, :func:`resizeterm` and
14311431
:func:`resize_term`.
@@ -1728,15 +1728,15 @@ falls back on a crude printable ASCII approximation.
17281728
+------------------------+------------------------------------------+
17291729
| ACS code | Meaning |
17301730
+========================+==========================================+
1731-
| .. data:: ACS_BBSS | alternate name for upper right corner |
1731+
| .. data:: ACS_BBSS | alternate name for upper-right corner |
17321732
+------------------------+------------------------------------------+
17331733
| .. data:: ACS_BLOCK | solid square block |
17341734
+------------------------+------------------------------------------+
17351735
| .. data:: ACS_BOARD | board of squares |
17361736
+------------------------+------------------------------------------+
17371737
| .. data:: ACS_BSBS | alternate name for horizontal line |
17381738
+------------------------+------------------------------------------+
1739-
| .. data:: ACS_BSSB | alternate name for upper left corner |
1739+
| .. data:: ACS_BSSB | alternate name for upper-left corner |
17401740
+------------------------+------------------------------------------+
17411741
| .. data:: ACS_BSSS | alternate name for top tee |
17421742
+------------------------+------------------------------------------+
@@ -1762,9 +1762,9 @@ falls back on a crude printable ASCII approximation.
17621762
+------------------------+------------------------------------------+
17631763
| .. data:: ACS_LEQUAL | less-than-or-equal-to |
17641764
+------------------------+------------------------------------------+
1765-
| .. data:: ACS_LLCORNER | lower left-hand corner |
1765+
| .. data:: ACS_LLCORNER | lower-left corner |
17661766
+------------------------+------------------------------------------+
1767-
| .. data:: ACS_LRCORNER | lower right-hand corner |
1767+
| .. data:: ACS_LRCORNER | lower-right corner |
17681768
+------------------------+------------------------------------------+
17691769
| .. data:: ACS_LTEE | left tee |
17701770
+------------------------+------------------------------------------+
@@ -1788,13 +1788,13 @@ falls back on a crude printable ASCII approximation.
17881788
+------------------------+------------------------------------------+
17891789
| .. data:: ACS_S9 | scan line 9 |
17901790
+------------------------+------------------------------------------+
1791-
| .. data:: ACS_SBBS | alternate name for lower right corner |
1791+
| .. data:: ACS_SBBS | alternate name for lower-right corner |
17921792
+------------------------+------------------------------------------+
17931793
| .. data:: ACS_SBSB | alternate name for vertical line |
17941794
+------------------------+------------------------------------------+
17951795
| .. data:: ACS_SBSS | alternate name for right tee |
17961796
+------------------------+------------------------------------------+
1797-
| .. data:: ACS_SSBB | alternate name for lower left corner |
1797+
| .. data:: ACS_SSBB | alternate name for lower-left corner |
17981798
+------------------------+------------------------------------------+
17991799
| .. data:: ACS_SSBS | alternate name for bottom tee |
18001800
+------------------------+------------------------------------------+
@@ -1808,9 +1808,9 @@ falls back on a crude printable ASCII approximation.
18081808
+------------------------+------------------------------------------+
18091809
| .. data:: ACS_UARROW | up arrow |
18101810
+------------------------+------------------------------------------+
1811-
| .. data:: ACS_ULCORNER | upper left corner |
1811+
| .. data:: ACS_ULCORNER | upper-left corner |
18121812
+------------------------+------------------------------------------+
1813-
| .. data:: ACS_URCORNER | upper right corner |
1813+
| .. data:: ACS_URCORNER | upper-right corner |
18141814
+------------------------+------------------------------------------+
18151815
| .. data:: ACS_VLINE | vertical line |
18161816
+------------------------+------------------------------------------+
@@ -1886,9 +1886,9 @@ The module :mod:`!curses.textpad` defines the following function:
18861886

18871887
Draw a rectangle. The first argument must be a window object; the remaining
18881888
arguments are coordinates relative to that window. The second and third
1889-
arguments are the y and x coordinates of the upper left hand corner of the
1889+
arguments are the y and x coordinates of the upper-left corner of the
18901890
rectangle to be drawn; the fourth and fifth arguments are the y and x
1891-
coordinates of the lower right hand corner. The rectangle will be drawn using
1891+
coordinates of the lower-right corner. The rectangle will be drawn using
18921892
VT100/IBM PC forms characters on terminals that make this possible (including
18931893
xterm and most other software terminal emulators). Otherwise it will be drawn
18941894
with ASCII dashes, vertical bars, and plus signs.
@@ -1909,7 +1909,7 @@ You can instantiate a :class:`Textbox` object as follows:
19091909
be contained. If *insert_mode* is true, the textbox inserts typed
19101910
characters, shifting existing text to the right, rather than overwriting it.
19111911
The edit cursor of the textbox is initially located at the
1912-
upper left hand corner of the containing window, with coordinates ``(0, 0)``.
1912+
upper-left corner of the containing window, with coordinates ``(0, 0)``.
19131913
The instance's :attr:`stripspaces` flag is initially on.
19141914

19151915
:class:`Textbox` objects have the following methods:

0 commit comments

Comments
 (0)