summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-10-04 11:57:14 (GMT)
committerGitHub <noreply@github.com>2023-10-04 11:57:14 (GMT)
commit7ec34874e3778267028f4938b30c769b69c8a0b2 (patch)
treeb1022e27814ca627813c6de848902374cafa7c89
parentee2f2bdb306a9ea286a64308376adfe5329367f0 (diff)
downloadcpython-7ec34874e3778267028f4938b30c769b69c8a0b2.zip
cpython-7ec34874e3778267028f4938b30c769b69c8a0b2.tar.gz
cpython-7ec34874e3778267028f4938b30c769b69c8a0b2.tar.bz2
[3.12] gh-85984: Document change in return type of tty functions (GH-110028) (#110324)
gh-85984: Document change in return type of tty functions (GH-110028) (cherry picked from commit f02f26e29366513b097578fbc6b25e02d0eba7c0) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
-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::