Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-101100: Fix sphinx warnings inlibrary/socketserver.rst
#110207
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Doc/library/socketserver.rst Outdated
@@ -116,23 +116,23 @@ server is the address family. | |||
:class:`ForkingMixIn` and the Forking classes mentioned below are | |||
only available on POSIX platforms that support :func:`~os.fork`. | |||
:meth:`socketserver.ForkingMixIn.server_close` waits until all child | |||
:meth:`!ForkingMixIn.server_close` waits until all child |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Should all these be documented rather than excluding via!
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
They are documented, but in a base class. I don't think that we should document implementation methods, they are just, well, implementations :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
cpython/Doc/library/socketserver.rst
Line 251 in777f882
..method::server_close() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Verbose, but a potential option?
:meth:`!ForkingMixIn.server_close` waits until all child | |
:meth:`ForkingMixIn.server_close <BaseServer.server_close>` waits until all child |
I think it might be worth documenting these methods, though, as their behaviour does differ significantly.
A
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I like the verbose option :)
I don't agree that their behavior is different: they all just clean things up afterwards. But in a different way (which is an implementation detail that should not be a part of the docs).
…ythonGH-110207)(cherry picked from commit756062b)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
GH-110623 is a backport of this pull request to the3.12 branch. |
…ythonGH-110207)(cherry picked from commit756062b)Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
GH-110624 is a backport of this pull request to the3.11 branch. |
Uh oh!
There was an error while loading.Please reload this page.
Before:
📚 Documentation preview 📚:https://cpython-previews--110207.org.readthedocs.build/