From: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Date: Wed, 4 Oct 2023 03:46:38 +0000 (-0700)
Subject: gh-85984: Document change in return type of tty functions (#110028)
X-Git-Tag: v3.13.0a1~154
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f02f26e29366513b097578fbc6b25e02d0eba7c0;p=thirdparty%2FPython%2Fcpython.git

gh-85984: Document change in return type of tty functions (#110028)
---

diff --git a/Doc/library/tty.rst b/Doc/library/tty.rst
index fc7f98c7931f..a4777772e1fc 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::