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 warning in library/http.cookies.rst #112908

Merged
merged 3 commits into from
Dec 10, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Dec 9, 2023

Fix these warnings:

SPHINXERRORHANDLING=-n PATH=./venv/bin:$PATH sphinx-build -b html -d build/doctrees -j auto -n . build/html library/http.cookies.rst 2>&1 | grep WARNING | tee >(wc -l)
Doc/library/http.cookies.rst:57: WARNING: py:meth reference target not found: value_decode
Doc/library/http.cookies.rst:57: WARNING: py:meth reference target not found: value_encode
Doc/library/http.cookies.rst:144: WARNING: py:attr reference target not found: httponly
Doc/library/http.cookies.rst:148: WARNING: py:attr reference target not found: samesite
Doc/library/http.cookies.rst:155: WARNING: py:meth reference target not found: Morsel.__eq__
Doc/library/http.cookies.rst:164: WARNING: py:attr reference target not found: samesite
       6

Plus refer to MSIE 3.0x in the past tense (EOL since something like 2003! Should we even remove that bit?), make cookie lowercase, adjust some formatting.


📚 Documentation preview 📚: https://cpython-previews--112908.org.readthedocs.build/en/112908/library/http.cookies.html

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Looks great overall! A few small suggestions:

Doc/library/http.cookies.rst Outdated Show resolved Hide resolved
Doc/library/http.cookies.rst Outdated Show resolved Hide resolved
Doc/library/http.cookies.rst Outdated Show resolved Hide resolved
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

🍪🎉

@hugovk hugovk merged commit 7595d47 into python:main Dec 10, 2023
25 checks passed
@hugovk hugovk deleted the docs-fix-sphinx-warnings-http.cookies branch December 10, 2023 12:53
@miss-islington-app
Copy link

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

@bedevere-app
Copy link

bedevere-app bot commented Dec 10, 2023

GH-112929 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 Dec 10, 2023
@bedevere-app
Copy link

bedevere-app bot commented Dec 10, 2023

GH-112930 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 Dec 10, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 10, 2023
…onGH-112908)

(cherry picked from commit 7595d47)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 10, 2023
…onGH-112908)

(cherry picked from commit 7595d47)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk pushed a commit that referenced this pull request Dec 10, 2023
…112908) (#112929)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Fix Sphinx warning in library/http.cookies.rst (GH-112908)
hugovk pushed a commit that referenced this pull request Dec 10, 2023
…112908) (#112930)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Fix Sphinx warning in library/http.cookies.rst (GH-112908)
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants