Title: bpo-29428: make doctest documentation clearer by JDLH · Pull Request #45 · python/cpython · GitHub
Open Graph Title: bpo-29428: make doctest documentation clearer by JDLH · Pull Request #45 · python/cpython
X Title: bpo-29428: make doctest documentation clearer by JDLH · Pull Request #45 · python/cpython
Description: A fix for bug bpo-29428, Doctest documentation unclear about multi-line fixtures. This changes Doc/library/doctest.rst only. No code changes. Clarify the introduction of section, "How are Docstring Examples Recognized", by moving it to above the example and rewriting for clarity. Change the example in that section to use more plausible code, which also demonstrates a multi-line test fixture. Add three "fine print" points, about the example prefix strings, blank expected output, and multi-line expected output. Clarify the introduction of section, "What's the Execution Context", by rewriting for clarity, and breaking into three paragraphs. Copy-edit the first paragraph in section, "Which Docstrings Are Examined?".
Open Graph Description: A fix for bug bpo-29428, Doctest documentation unclear about multi-line fixtures. This changes Doc/library/doctest.rst only. No code changes. Clarify the introduction of section, "How are Docs...
X Description: A fix for bug bpo-29428, Doctest documentation unclear about multi-line fixtures. This changes Doc/library/doctest.rst only. No code changes. Clarify the introduction of section, "How are ...
Opengraph URL: https://github.com/python/cpython/pull/45
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:5d2c3359-9b26-7a24-c9e5-4d081fb41add |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | 8132:37777E:83CF1:AE9C6:696AD123 |
| html-safe-nonce | 89586aec42f681dd5cbd5f2bb478ea7a8cb128aee3fb7991a88883f88707b77e |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MTMyOjM3Nzc3RTo4M0NGMTpBRTlDNjo2OTZBRDEyMyIsInZpc2l0b3JfaWQiOiI1MzgwMTAyNzk4MTI2NTM0OTQ3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | abff21a5431c34053081da2634efae28a5f5e0e92fb6787a9cd25b4e2844a8a6 |
| hovercard-subject-tag | pull_request:105783161 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,checks,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python/cpython/pull/45/checks |
| twitter:image | https://avatars.githubusercontent.com/u/1100216?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1100216?s=400&v=4 |
| og:image:alt | A fix for bug bpo-29428, Doctest documentation unclear about multi-line fixtures. This changes Doc/library/doctest.rst only. No code changes. Clarify the introduction of section, "How are Docs... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | c785f4ce187e9e7331257791b36ddee01625bb8e292a9b4fe2c16d4c006abf5d |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive full-width full-width-p-0 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | c718a376fcf780eb22089171adb84a543f660bf7 |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width