◐ Shell
reader mode source ↗
Skip to content

gh-101100: Fix dangling references in test.rst#114958

Open
smontanaro wants to merge 9 commits into
python:mainfrom
smontanaro:patch-9
Open

gh-101100: Fix dangling references in test.rst#114958
smontanaro wants to merge 9 commits into
python:mainfrom
smontanaro:patch-9

Conversation

@smontanaro

@smontanaro smontanaro commented Feb 3, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

Further cleanup related to #114770.

One or two typos. Mostly I just suppressed the dangling references, because this module is just meant for core dev usage.

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

@bedevere-app bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Feb 3, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Feb 3, 2024
Open
@hugovk

hugovk commented Feb 4, 2024

Copy link
Copy Markdown
Member

🎉

Congratulations! You improved:

Doc/library/test.rst

Please remove from Doc/tools/.nitignore

Let's combine #114770 into this one, they need to be atomic for the CI to be green and mergeable.

@smontanaro smontanaro mentioned this pull request Feb 12, 2024
Closed
@smontanaro

smontanaro commented Feb 12, 2024

Copy link
Copy Markdown
Contributor Author

Let's combine #114770 into this one

Done. I also closed that PR.

@smontanaro

smontanaro commented Feb 16, 2024

Copy link
Copy Markdown
Contributor Author

Can we move this forward? Is there more people think needs to be done?

@AlexWaygood

AlexWaygood commented Feb 16, 2024

Copy link
Copy Markdown
Member

Can we move this forward? Is there more people think needs to be done?

there's a merge conflict

@smontanaro

smontanaro commented Feb 16, 2024

Copy link
Copy Markdown
Contributor Author

there's a merge conflict

Better now? I saw the alert in the web interface, but didn't see a conflict in my sandbox. I must have missed a step in there somewhere. I just resolved it through the web interface.

@smontanaro

smontanaro commented Feb 16, 2024

Copy link
Copy Markdown
Contributor Author

Once it is merged, let me try to take care of 3.12 and 3.11 (assuming these changes are backported). I have a local version of cherry_picker with some minimal color support I'd like to exercise a bit.

@CAM-Gerlach CAM-Gerlach added only security fixes needs backport to 3.12 only security fixes labels Feb 21, 2024
CAM-Gerlach
CAM-Gerlach requested changes Feb 21, 2024
View reviewed changes

@CAM-Gerlach CAM-Gerlach 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.

Hide comment

A general comment: IMO, it is much better to just leave valid warnings due to missing documentation than to take the easy way out and just hide them, as doing so defeats one of the most meaningful benefits of these warnings in the first place—identifying gaps in the docs where we haven't formally documented something that should be public. To be honest, I'd rather people not fix the trivial cases at all if that comes at the cost of ignoring the more important ones.

@bedevere-app

bedevere-app Bot commented Feb 21, 2024

Copy link
Copy Markdown

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.

And if you don't make the requested changes, you will be put in the comfy chair!

@smontanaro

smontanaro commented Feb 23, 2024

Copy link
Copy Markdown
Contributor Author

@CAM-Gerlach I can't see how I'm supposed to respond to your comment about the suppressed SO_REUSEADDR and SO_REUSEPORT attributes. Neither of those attributes is defined in the socket documentation (though mentioned a couple times). I'm not keen on reproducing bits of external documentation, especially as in this case where it means exactly the same thing in Python as in C.

Also note that the text near these suppressed links says basically, "Don't use these in tests!"

@smontanaro @CAM-Gerlach
Apply suggestions from code review …
38194c5 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@hugovk hugovk removed the needs backport to 3.11 only security fixes label Apr 11, 2024
@serhiy-storchaka serhiy-storchaka added the needs backport to 3.13 bugs and security fixes label May 9, 2024
@hugovk hugovk removed the needs backport to 3.12 only security fixes label Apr 10, 2025
@serhiy-storchaka serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
@github-actions

github-actions Bot commented Apr 15, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 15, 2026
@serhiy-storchaka serhiy-storchaka added the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 30, 2026
@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Jun 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz left review comments

@AlexWaygood AlexWaygood AlexWaygood left review comments

@CAM-Gerlach CAM-Gerlach CAM-Gerlach requested changes

Assignees

No one assigned

Labels

awaiting changes docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@smontanaro @hugovk @AlexWaygood @picnixz @CAM-Gerlach @serhiy-storchaka