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

gh-101100: Fix sphinx warnings in `library/getpass.rst` by sobolevn · Pull Request #110461 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-101100: Fix sphinx warnings in library/getpass.rst - #110461

Merged
hugovk merged 1 commit into
python:mainfrom
sobolevn:issue-101100-getpass
Oct 19, 2023
ConversationCommits (1)ChecksFiles changed
Merged

gh-101100: Fix sphinx warnings in library/getpass.rst#110461
hugovk merged 1 commit into
python:mainfrom
sobolevn:issue-101100-getpass

Conversation

sobolevn commented Oct 6, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Before:

/Users/sobolev/Desktop/cpython/Doc/library/getpass.rst:45: WARNING: 'envvar' reference target not found: LNAME

I don't think that we need to document this Linux-specific variable.
We don't document any other env vars from this function:

~/Desktop/cpython  main ✗                                                                 
» ag '.. envvar:: USER' Doc
                                                                                           
~/Desktop/cpython  main ✗                                                              1 ⚠️
» ag '.. envvar:: LOG' Doc

But, they are pre-defined in Sphinx, I guess. But, not LNAME.
So, just ignore it.

📚 Documentation preview 📚: https://cpython-previews--110461.org.readthedocs.build/

sobolevn requested review from AA-Turner and hugovk October 6, 2023 08:17
bedevere-app Bot mentioned this pull request Oct 6, 2023
Closed
hugovk added skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Oct 6, 2023
hugovk approved these changes Oct 6, 2023
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Interesting that they don't link anywhere or change the formatting:

https://cpython-previews--110461.org.readthedocs.build/en/110461/library/getpass.html#module-getpass

Anyway, thanks, looks good.

hugovk merged commit d144749 into python:main Oct 19, 2023

miss-islington-app Bot commented Oct 19, 2023

Copy link
Copy Markdown

Thanks @sobolevn for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington-app Bot commented Oct 19, 2023

Copy link
Copy Markdown

Sorry, @sobolevn and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker d144749914dbe295d71d037e8ca695783511123f 3.12

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 19, 2023
pythongh-101100: Fix sphinx warnings in library/getpass.rst (python…
915edb8 
…GH-110461)

(cherry picked from commit d144749)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

bedevere-app Bot commented Oct 19, 2023

Copy link
Copy Markdown

GH-111072 is a backport of this pull request to the 3.11 branch.

bedevere-app Bot removed the needs backport to 3.11 only security fixes label Oct 19, 2023
hugovk pushed a commit to hugovk/cpython that referenced this pull request Oct 19, 2023
[3.12] pythongh-101100: Fix sphinx warnings in library/getpass.rst (p…
cddd789 
…ythonGH-110461).

(cherry picked from commit d144749)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
hugovk pushed a commit to hugovk/cpython that referenced this pull request Oct 19, 2023
[3.12] pythongh-101100: Fix sphinx warnings in library/getpass.rst (p…
f842c3b 
…ythonGH-110461).

(cherry picked from commit d144749)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

bedevere-app Bot commented Oct 19, 2023

Copy link
Copy Markdown

GH-111080 is a backport of this pull request to the 3.12 branch.

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Oct 19, 2023
hugovk pushed a commit that referenced this pull request Oct 19, 2023
[3.11] gh-101100: Fix sphinx warnings in library/getpass.rst (GH-11…
4fc5352 
…0461) (#111072)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
hugovk added a commit that referenced this pull request Oct 19, 2023
[3.12] gh-101100: Fix sphinx warnings in library/getpass.rst (GH-11…
41dfae8 
…0461) (#111080)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
pythongh-101100: Fix sphinx warnings in library/getpass.rst (python…
8b95ee9 
…#110461)
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
pythongh-101100: Fix sphinx warnings in library/getpass.rst (python…
cf19f60 
…#110461)
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk approved these changes
AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

hugovk

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL