]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-101100: Fix Sphinx warnings in `library/tty.rst` (GH-111079) (#111097)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 20 Oct 2023 04:49:41 +0000 (06:49 +0200)
committerGitHub <noreply@github.com>
Fri, 20 Oct 2023 04:49:41 +0000 (07:49 +0300)
gh-101100: Fix Sphinx warnings in `library/tty.rst` (GH-111079)

Fix Sphinx warnings in library/tty.rst
(cherry picked from commit c42c68aa7bd19b0de7f2132ed468bc4ce83d8aa9)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
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 f55c238489d4f315b87e56ecc9d72592df73a990..2297a6aba748dc92e909e165bcd37554232ec349 100644 (file)
@@ -135,7 +135,6 @@ Doc/library/tkinter.scrolledtext.rst
 Doc/library/tkinter.tix.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