Skip to content

gh-101100: Fix references in http.cookiejar docs #114658 #136238

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

Conversation

LamentXU123
Copy link
Contributor

@LamentXU123 LamentXU123 commented Jul 3, 2025

The origial doc is:

image

Since there is no highlights or any reference, I see no reason to split the doc of strict_ns_domain. I think maybe we can make the description of the acceptable value just below strict_ns_domain? The two addtributes within are likely to be added in the wrong place.

Another thing is the referrence link of strict_ns_domain is invalid in the original doc, since it's been interrupted and can't locate the attribute. (The .rst file is here)

This PR change it to:

image

Skipping issues and news ;)


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

Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

Please keep it as is. The attributes documented after this "weird" paragraph are the flags. This paragraph serves as a separation between regulat attributes and class variable constants that behave like flags.

In the future, please first create an issue to discuss such changes before or carefully check that there is something to change.

Note: the backlink is an issue that can be solved by this PR but don't move around the docs. Just add the DefaultCookiePolicy namespace and the ~ to suppress the fully qualified name.

@bedevere-app
Copy link

bedevere-app bot commented Jul 4, 2025

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@picnixz
Copy link
Member

picnixz commented Jul 4, 2025

Use the issue that aims to remove warnings in the docs for this one.

@LamentXU123 LamentXU123 changed the title Doc: Fix interrupting words in doc ofDefaultCookiePolicy.strict_ns_domain gh-101100: Fix references in http.cookiejar docs #114658 Jul 5, 2025
@LamentXU123
Copy link
Contributor Author

LamentXU123 commented Jul 5, 2025

Done. Thank you for your review.

image

@LamentXU123
Copy link
Contributor Author

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Jul 5, 2025

Thanks for making the requested changes!

@picnixz: please review the changes made to this pull request.

@bedevere-app bedevere-app bot requested a review from picnixz July 5, 2025 03:50
@picnixz
Copy link
Member

picnixz commented Jul 5, 2025

@ZeroIntensity Can you remove my old review and merge this one? TiA

Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

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

Silly bot

@ZeroIntensity ZeroIntensity merged commit f0c7344 into python:main Jul 5, 2025
31 of 33 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jul 5, 2025
@ZeroIntensity ZeroIntensity added awaiting merge needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 5, 2025
@miss-islington-app
Copy link

Thanks @LamentXU123 for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @LamentXU123 for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 5, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 5, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 5, 2025

GH-136317 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 5, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jul 5, 2025

GH-136318 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 5, 2025
ZeroIntensity pushed a commit that referenced this pull request Jul 5, 2025
…GH-136318)

gh-101100: Fix references in `http.cookiejar` docs (GH-136238)
(cherry picked from commit f0c7344)

Co-authored-by: Weilin Du <[email protected]>
ZeroIntensity pushed a commit that referenced this pull request Jul 5, 2025
…GH-136317)

gh-101100: Fix references in `http.cookiejar` docs (GH-136238)
(cherry picked from commit f0c7344)

Co-authored-by: Weilin Du <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting merge docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants