Add missing cross-references to improve navigation in getpass.rst#151092
Conversation
bedevere-app
Bot
added
awaiting review
docs
sergiolpzgmz
force-pushed
the
add-missing-cross-references-in-getpass
branch
from
34dc965 to
c5d4779
Compare
Documentation build overview
5 files changed ·
|
|
|
||
| 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
:meth: is tested, and works. It looks like the problem here with linklint is getpass.getpass vs getpass. In this line, I tried all combinations (using ' here instead of `):
:meth:'getpass' is linked.
:meth:'getpass.getpass' is linked
:meth:'~getpass.getpass' is linked
:func:'getpass' is NOT linked.
:func:'getpass.getpass' is linked
:func:'~getpass.getpass' is linked
So to remain unlinked, the type has to match (func), and the name can't be fully qualified. I thought linklint was better about that....
There was a problem hiding this comment.
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
linklintbug (or workaround)!
I see the point. I interpreted the guidance too broadly and ended up applying a link where it wasn’t really adding value in context. I’ll revise the change to better align with the intended usage
|
|
||
| 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 |
There was a problem hiding this comment.
While we are here:
| If echo free input is unavailable :meth:`~getpass.getpass` falls back to printing | |
| If echo-free input is unavailable :func:`getpass` falls back to printing |
There was a problem hiding this comment.
Thanks for the review, I'll keep that in mind.
|
|
||
| .. 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 |
There was a problem hiding this comment.
| If you call :meth:`~getpass.getpass` from within IDLE, the input may be done in the | |
| If you call :func:`getpass` from within IDLE, the input may be done in the |
|
Linklint 1.0.1 will properly resolve and unlink these references. |
|
Thanks for the reviews! |
4 participants
No description provided.