Title: Add discussion of doctesting interactive code examples. · Issue #1134 · python/devguide · GitHub
Open Graph Title: Add discussion of doctesting interactive code examples. · Issue #1134 · python/devguide
X Title: Add discussion of doctesting interactive code examples. · Issue #1134 · python/devguide
Description: There have been various discussions about doctesting interactive code examples in the python docs. The consensus has been that it is desirable that they pass. Indeed, CI currently has a (pass-not-required) Tests / Docs / Doctest. (But it...
Open Graph Description: There have been various discussions about doctesting interactive code examples in the python docs. The consensus has been that it is desirable that they pass. Indeed, CI currently has a (pass-not-r...
X Description: There have been various discussions about doctesting interactive code examples in the python docs. The consensus has been that it is desirable that they pass. Indeed, CI currently has a (pass-not-r...
Opengraph URL: https://github.com/python/devguide/issues/1134
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Add discussion of doctesting interactive code examples.","articleBody":"There have been various discussions about doctesting interactive code examples in the python docs. The consensus has been that it is desirable that they pass. Indeed, CI currently has a (pass-not-required) Tests / Docs / Doctest. (But it seems to be setup to be excessively lenient, passing many errors that are normally caught. Intended? Bug?) There has been additional discussion about use of particular features, such as doctest directives. An example from the [doc](https://docs.python.org/3/library/doctest.html#warnings):\r\n```\r\nThe [ELLIPSIS](https://docs.python.org/3/library/doctest.html#doctest.ELLIPSIS) directive\r\ngives a nice approach for the last example:\r\n>>> C() # doctest: +ELLIPSIS\r\n\u003cC object at 0x...>\r\n```\r\nOther people may remember such discussions better. In any case, a summary of current policy should be added either in \r\nDocumentation / Style Guide /Code Examples or in a new \"Interactive Code Examples and Doctest\" section immediately after.\r\n\r\n","author":{"url":"https://github.com/terryjreedy","@type":"Person","name":"terryjreedy"},"datePublished":"2023-07-13T19:35:37Z","url":"https://github.com/python/devguide/issues/1134"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:7b39a0de-320f-0bd8-6cd6-b71fc83f4613 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A71A:5D487:127956A:187D8E2:6B01EEFE |
| html-safe-nonce | 451f663c19636d0d0096e3daeaddbac6237224f96fe7478deca829d74fa49650 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBNzFBOjVENDg3OjEyNzk1NkE6MTg3RDhFMjo2QjAxRUVGRSIsInZpc2l0b3JfaWQiOiI0ODY5MzAwMTQ3MjA2NjE0NzgyIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | db863e674a10c9335f30cbe8f2103a88ef8914c609b694aeb4528942a75be0d5 |
| hovercard-subject-tag | issue:1803649878 |
| github-keyboard-shortcuts | repository,issues,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/_view_fragments/issues/show/python/devguide/1134/issue_layout |
| twitter:image | https://opengraph.githubassets.com/f4ed1535766d02d16e023fd95885d53998635185a8ef887f38d705338795ce02/python/devguide/issues/1134 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/f4ed1535766d02d16e023fd95885d53998635185a8ef887f38d705338795ce02/python/devguide/issues/1134 |
| og:image:alt | There have been various discussions about doctesting interactive code examples in the python docs. The consensus has been that it is desirable that they pass. Indeed, CI currently has a (pass-not-r... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | terryjreedy |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/devguide git https://github.com/python/devguide.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 63972479 |
| octolytics-dimension-repository_nwo | python/devguide |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 63972479 |
| octolytics-dimension-repository_network_root_nwo | python/devguide |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width