]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101100: Fix Sphinx warnings in `library/tty.rst` (#111079)
authorHugo van Kemenade <hugovk@users.noreply.github.com>
Fri, 20 Oct 2023 04:33:17 +0000 (07:33 +0300)
committerGitHub <noreply@github.com>
Fri, 20 Oct 2023 04:33:17 +0000 (07:33 +0300)
Fix Sphinx warnings in library/tty.rst

Doc/library/termios.rst
Doc/tools/.nitignore

index fb1ff567d49e5c86225f2d28477b536f7ee7d6f8..03806178e9d3fbd89b6600f1a5f5ab7be8529ad1 100644 (file)
@@ -43,10 +43,20 @@ The module defines the following functions:
 
    Set the tty attributes for file descriptor *fd* from the *attributes*, which is
    a list like the one returned by :func:`tcgetattr`.  The *when* argument
-   determines when the attributes are changed: :const:`TCSANOW` to change
-   immediately, :const:`TCSADRAIN` to change after transmitting all queued output,
-   or :const:`TCSAFLUSH` to change after transmitting all queued output and
-   discarding all queued input.
+   determines when the attributes are changed:
+
+   .. data:: TCSANOW
+
+      Change attributes immediately.
+
+   .. data:: TCSADRAIN
+
+      Change attributes after transmitting all queued output.
+
+   .. data:: TCSAFLUSH
+
+      Change attributes after transmitting all queued output and
+      discarding all queued input.
 
 
 .. function:: tcsendbreak(fd, duration)
index f44f9e65b9b530675e11ee5d6faafb8df3bceb5a..5b21d11271d598b78b6c30f573182db7f2046424 100644 (file)
@@ -119,7 +119,6 @@ Doc/library/tkinter.rst
 Doc/library/tkinter.scrolledtext.rst
 Doc/library/tkinter.ttk.rst
 Doc/library/traceback.rst
-Doc/library/tty.rst
 Doc/library/unittest.mock.rst
 Doc/library/unittest.rst
 Doc/library/urllib.parse.rst