]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-85984: Document change in return type of tty functions (GH-110028) (#110324)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 4 Oct 2023 11:57:14 +0000 (04:57 -0700)
committerGitHub <noreply@github.com>
Wed, 4 Oct 2023 11:57:14 +0000 (13:57 +0200)
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>
Doc/library/tty.rst

index fc7f98c7931fa5752ed04f68eb35867bd4b725a0..a4777772e1fc6c84a398ce7d094643bc4268f8c7 100644 (file)
@@ -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::