summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJelle Zijlstra <jelle.zijlstra@gmail.com>2023-10-04 03:46:38 (GMT)
committerGitHub <noreply@github.com>2023-10-04 03:46:38 (GMT)
commitf02f26e29366513b097578fbc6b25e02d0eba7c0 (patch)
treeeef7bdc9d775dd43570fc84da0ecc3dadaf25a41
parent269005e78429d6ee518643daa633e9aa7e8b9c33 (diff)
downloadcpython-f02f26e29366513b097578fbc6b25e02d0eba7c0.zip
cpython-f02f26e29366513b097578fbc6b25e02d0eba7c0.tar.gz
cpython-f02f26e29366513b097578fbc6b25e02d0eba7c0.tar.bz2
gh-85984: Document change in return type of tty functions (#110028)
-rw-r--r--Doc/library/tty.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/library/tty.rst b/Doc/library/tty.rst
index fc7f98c..a477777 100644
--- a/Doc/library/tty.rst
+++ b/Doc/library/tty.rst
@@ -43,6 +43,9 @@ The :mod:`tty` module defines the following functions:
:func:`termios.tcsetattr`. The return value of :func:`termios.tcgetattr`
is saved before setting *fd* to raw mode; this value is returned.
+ .. versionchanged:: 3.12
+ The return value is now the original tty attributes, instead of None.
+
.. function:: setcbreak(fd, when=termios.TCSAFLUSH)
@@ -51,6 +54,9 @@ The :mod:`tty` module defines the following functions:
:func:`termios.tcsetattr`. The return value of :func:`termios.tcgetattr`
is saved before setting *fd* to cbreak mode; this value is returned.
+ .. versionchanged:: 3.12
+ The return value is now the original tty attributes, instead of None.
+
.. seealso::