Skip to content

Add missing cross-references to improve navigation in getpass.rst #151092

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
sergiolpzgmz wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −4
Open

Add missing cross-references to improve navigation in getpass.rst #151092

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5d4779
Add missing cross-references in getpass.rst to improve navigation
sergiolpzgmz Jun 8, 2026
7425148
Merge branch 'main' into add-missing-cross-references-in-getpass
sergiolpzgmz Jun 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Doc/library/getpass.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The :mod:`!getpass` module provides two functions:
the string *prompt*, which defaults to ``'Password: '``. On Unix, the
prompt is written to the file-like object *stream* using the replace error
handler if needed. *stream* defaults to the controlling terminal
(:file:`/dev/tty`) or if that is unavailable to ``sys.stderr`` (this
(:file:`/dev/tty`) or if that is unavailable to :data:`sys.stderr` (this
argument is ignored on Windows).

The *echo_char* argument controls how user input is displayed while typing.
Expand All @@ -27,12 +27,12 @@ The :mod:`!getpass` module provides two functions:
typed character is replaced by it. For example, ``echo_char='*'`` will
display asterisks instead of the actual input.

If echo free input is unavailable getpass() falls back to printing
a warning message to *stream* and reading from ``sys.stdin`` and
If echo free input is unavailable :meth:`~getpass.getpass` falls back to printing
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Jun 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want to link to a function in its documentation, see the style guide for more information on links. However, you also found a linklint bug (or workaround)!

CC @nedbat for the bug.

a warning message to *stream* and reading from :data:`sys.stdin` and
issuing a :exc:`GetPassWarning`.

.. note::
If you call getpass from within IDLE, the input may be done in the
If you call :meth:`~getpass.getpass` from within IDLE, the input may be done in the
terminal you launched IDLE from rather than the idle window itself.

.. note::
Expand Down
Loading