Title: Random walk documentation improvements · Issue #107432 · python/cpython · GitHub
Open Graph Title: Random walk documentation improvements · Issue #107432 · python/cpython
X Title: Random walk documentation improvements · Issue #107432 · python/cpython
Description: Across the documentation there are numerous examples of scope for improvement. Many of these could be described as housekeeping opportunities - documentation that is fundamentally sound, but needs to be updated and tidied up. An example ...
Open Graph Description: Across the documentation there are numerous examples of scope for improvement. Many of these could be described as housekeeping opportunities - documentation that is fundamentally sound, but needs ...
X Description: Across the documentation there are numerous examples of scope for improvement. Many of these could be described as housekeeping opportunities - documentation that is fundamentally sound, but needs ...
Opengraph URL: https://github.com/python/cpython/issues/107432
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Random walk documentation improvements","articleBody":"Across the documentation there are numerous examples of scope for improvement. Many of these could be described as housekeeping opportunities - documentation that is fundamentally sound, but needs to be updated and tidied up.\r\n\r\nAn example is [Porting Python 2 Code to Python 3](https://docs.python.org/3/howto/pyporting.html#porting-python-2-code-to-python-3), which was written in a different era.\r\n\r\nThese are the kind of thing that will be discovered in a random walk through the documentation, one thing leading to another. A random walk will also uncover (often small) possibilities for improvement that would otherwise likely hide unnoticed in quiet corners. \r\n\r\n# Pitch\r\n\r\nI propose taking a random walk through the documentation, finding and taking low-hanging fruit where I go. As well as the value of the fixes themselves, the activity and discussion of issues as they come up with bring further opportunities to the surface, and place them in front of more eyes.\r\n\r\n# Discoveries and suggestions\r\n\r\n- [ ] https://docs.python.org/3/howto/annotations.html is not really a how-to - it's an explanation-type document\r\n- [ ] https://docs.python.org/3/howto/functional.html should be moved to an explanation section\r\n- [ ] https://docs.python.org/3/howto/isolating-extensions.html is explanation\r\n\r\n\u003c!-- gh-linked-prs --\u003e\r\n### Linked PRs\r\n* gh-107434\r\n* gh-107445\r\n* gh-107449\r\n* gh-107654\n* gh-107655\n* gh-108409\n* gh-108410\n\u003c!-- /gh-linked-prs --\u003e","author":{"url":"https://github.com/evildmp","@type":"Person","name":"evildmp"},"datePublished":"2023-07-29T16:02:17.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/107432/cpython/issues/107432"}
| 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:2e195370-3098-8a11-b923-837cb42ca0ef |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BCBE:2BFDE6:41394C:5F0560:6A4E059E |
| html-safe-nonce | b2def46d179262814685eaa3ced7c1e12fab3047d645ec3315a4ef6fcf56ec2e |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQ0JFOjJCRkRFNjo0MTM5NEM6NUYwNTYwOjZBNEUwNTlFIiwidmlzaXRvcl9pZCI6IjI2MjUxNDEyMzQ5NDc5ODI3NTAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 892a03611ea323b7344e2dd77588d766f99127d754f0d050d33785a84a6e0afc |
| hovercard-subject-tag | issue:1827531806 |
| 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/cpython/107432/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d42178d0876627a94f2b8ba9d1ec1ce7266e53d7f474b104dd7c41633a053694/python/cpython/issues/107432 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d42178d0876627a94f2b8ba9d1ec1ce7266e53d7f474b104dd7c41633a053694/python/cpython/issues/107432 |
| og:image:alt | Across the documentation there are numerous examples of scope for improvement. Many of these could be described as housekeeping opportunities - documentation that is fundamentally sound, but needs ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | evildmp |
| hostname | github.com |
| expected-hostname | github.com |
| None | df0492960db29b4938cb72070351d6b1d0c6c0767b27ceb8394bbf4fcc0223c6 |
| 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 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 52bde38e24398476f8eb1e0760c81346c6a00812 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width