summaryrefslogtreecommitdiffstats
path: root/Doc/library/termios.rst
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2023-10-20 04:33:17 (GMT)
committerGitHub <noreply@github.com>2023-10-20 04:33:17 (GMT)
commitc42c68aa7bd19b0de7f2132ed468bc4ce83d8aa9 (patch)
tree897bf8cba4f6fd96918c77c58253b35c876a2ce8 /Doc/library/termios.rst
parentb802882fb2bff8b431df661322908c07491f3ce7 (diff)
downloadcpython-c42c68aa7bd19b0de7f2132ed468bc4ce83d8aa9.zip
cpython-c42c68aa7bd19b0de7f2132ed468bc4ce83d8aa9.tar.gz
cpython-c42c68aa7bd19b0de7f2132ed468bc4ce83d8aa9.tar.bz2
gh-101100: Fix Sphinx warnings in `library/tty.rst` (#111079)
Fix Sphinx warnings in library/tty.rst
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)