FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-151950: Fix Sphinx reference warnings in termios docs by harjothkhara · Pull Request #153885 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-151950: Fix Sphinx reference warnings in termios docs #153885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
harjothkhara wants to merge 2 commits into
base: main
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

Are you sure you want to change the base?

Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
from
+34 −1
Conversation 2 Commits 2 Checks 26 Files changed 2
Open

gh-151950: Fix Sphinx reference warnings in termios docs #153885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92b778b
gh-151950: Fix Sphinx reference warnings in termios docs
harjothkhara Jul 18, 2026
7b6786f
Merge branch 'main' into docs-termios-gh-151950
harjothkhara Oct 23, 2026
File filter

Filter by extension

Filter by extension .rst  (1) dotfile  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
34 changes: 34 additions & 0 deletions Doc/library/termios.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ The module defines the following functions:
well as the indexing in the *cc* array must be done using the symbolic
constants defined in the :mod:`!termios` module.

.. data:: VMIN
VTIME

Indices into the *cc* array controlling a non-canonical read: the minimum
number of characters to read and the timeout in tenths of a second,
respectively.


.. function:: tcsetattr(fd, when, attributes)

Expand Down Expand Up @@ -77,13 +84,28 @@ The module defines the following functions:
which queue: :const:`TCIFLUSH` for the input queue, :const:`TCOFLUSH` for the
output queue, or :const:`TCIOFLUSH` for both queues.

.. data:: TCIFLUSH
TCOFLUSH
TCIOFLUSH

Values for the *queue* selector: the input queue, the output queue, or
both queues, respectively.


.. function:: tcflow(fd, action)

Suspend or resume input or output on file descriptor *fd*. The *action*
argument can be :const:`TCOOFF` to suspend output, :const:`TCOON` to restart
output, :const:`TCIOFF` to suspend input, or :const:`TCION` to restart input.

.. data:: TCOOFF
TCOON
TCIOFF
TCION

Values for the *action* argument: suspend output, restart output,
suspend input, or restart input, respectively.


.. function:: tcgetwinsize(fd)

Expand All @@ -93,6 +115,12 @@ The module defines the following functions:

.. versionadded:: 3.11

.. data:: TIOCGWINSZ
TIOCGSIZE

``ioctl()`` requests for querying the tty window size. Not defined on
all platforms; :func:`tcgetwinsize` requires at least one of them.


.. function:: tcsetwinsize(fd, winsize)

Expand All @@ -104,6 +132,12 @@ The module defines the following functions:

.. versionadded:: 3.11

.. data:: TIOCSWINSZ
TIOCSSIZE

``ioctl()`` requests for setting the tty window size. Not defined on all
platforms; see :func:`tcsetwinsize` for the required pairs.


.. seealso::

Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Doc/library/pyexpat.rst
Doc/library/select.rst
Doc/library/socket.rst
Doc/library/ssl.rst
Doc/library/termios.rst
Doc/library/urllib.parse.rst
Doc/library/urllib.request.rst
Doc/library/wsgiref.rst
Expand Down
Loading
Back | FazBrowse Home | New Git URL