Skip to content
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.

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

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

Merged
merged 1 commit into from Oct 19, 2023

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Oct 6, 2023

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/

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

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

image

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

Anyway, thanks, looks good.

@hugovk hugovk merged commit d144749 into python:main Oct 19, 2023
28 checks passed
@miss-islington-app
Copy link

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
Copy link

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
…GH-110461)

(cherry picked from commit d144749)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@bedevere-app
Copy link

bedevere-app bot commented Oct 19, 2023

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

@bedevere-app 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
…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
…ythonGH-110461).

(cherry picked from commit d144749)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@bedevere-app
Copy link

bedevere-app bot commented Oct 19, 2023

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Oct 19, 2023
hugovk pushed a commit that referenced this pull request Oct 19, 2023
…0461) (#111072)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
hugovk added a commit that referenced this pull request Oct 19, 2023
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants