summaryrefslogtreecommitdiffstats
path: root/Doc/library/termios.rst
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-10-20 04:49:41 (GMT)
committerGitHub <noreply@github.com>2023-10-20 04:49:41 (GMT)
commit909225172a473a26b3ea4bb9b1c10f5486e432ee (patch)
tree20bdf7040723c62d0aebc477ff76eaca799deea4 /Doc/library/termios.rst
parent42fd44ac97feaf4057ec26f15391fe63cdcaa4b5 (diff)
downloadcpython-909225172a473a26b3ea4bb9b1c10f5486e432ee.zip
cpython-909225172a473a26b3ea4bb9b1c10f5486e432ee.tar.gz
cpython-909225172a473a26b3ea4bb9b1c10f5486e432ee.tar.bz2
[3.12] gh-101100: Fix Sphinx warnings in `library/tty.rst` (GH-111079) (#111097)
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>
Diffstat (limited to 'Doc/library/termios.rst')
-rw-r--r--Doc/library/termios.rst18
1 files changed, 14 insertions, 4 deletions
diff --git a/Doc/library/termios.rst b/Doc/library/termios.rst
index fb1ff56..0380617 100644
--- a/Doc/library/termios.rst
+++ b/Doc/library/termios.rst
@@ -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)