Skip to content

Commit

Permalink
gh-85984: Document change in return type of tty functions (#110028)
Browse files Browse the repository at this point in the history
  • Loading branch information
JelleZijlstra authored Oct 4, 2023
1 parent 269005e commit f02f26e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Doc/library/tty.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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::

Expand Down

0 comments on commit f02f26e

Please sign in to comment.