-
-
Notifications
You must be signed in to change notification settings - Fork 30.8k
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/doctest.rst
#112399
Conversation
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.
Thanks!
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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.
LGTM, thanks!
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
Sorry, @hugovk, I could not cleanly backport this to
|
…nGH-112399) * Fix Sphinx warnings in library/doctest.rst * Don't link to self, and wrap a line Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Link to load_tests protocol * Link to option flags * Wrap line Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> --------- (cherry picked from commit 0303a9f) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
GH-112402 is a backport of this pull request to the 3.12 branch. |
Thanks for the review! |
GH-112404 is a backport of this pull request to the 3.11 branch. |
…pythonGH-112399) * Fix Sphinx warnings in library/doctest.rst * Don't link to self, and wrap a line Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Link to load_tests protocol * Link to option flags * Wrap line Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> --------- (cherry picked from commit 0303a9f) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
…n#112399) * Fix Sphinx warnings in library/doctest.rst * Don't link to self, and wrap a line Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Link to load_tests protocol * Link to option flags * Wrap line Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> --------- Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
…n#112399) * Fix Sphinx warnings in library/doctest.rst * Don't link to self, and wrap a line Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Link to load_tests protocol * Link to option flags * Wrap line Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> --------- Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Fixes 24 Sphinx warnings:
M
andf
are example code, skip 'em.These docs explicitly say "
DocTestCase
isn’t documented here (it’s an internal detail)" so skip it and its method too, and also the similarDocFileCase
.Add docs for the
failureException
exception.📚 Documentation preview 📚: https://cpython-previews--112399.org.readthedocs.build/