Title: Improve the sqlite3 reference · Issue #95273 · python/cpython · GitHub
Open Graph Title: Improve the sqlite3 reference · Issue #95273 · python/cpython
X Title: Improve the sqlite3 reference · Issue #95273 · python/cpython
Description: Improve the sqlite3 reference, using Diataxis as a guideline. A lot of work has already been done here, with great help from Alex Waygood and CAM Gerlach. PRs so far1 have focused on...: Be accurate Do nothing but describe; making the wo...
Open Graph Description: Improve the sqlite3 reference, using Diataxis as a guideline. A lot of work has already been done here, with great help from Alex Waygood and CAM Gerlach. PRs so far1 have focused on...: Be accurat...
X Description: Improve the sqlite3 reference, using Diataxis as a guideline. A lot of work has already been done here, with great help from Alex Waygood and CAM Gerlach. PRs so far1 have focused on...: Be accurat...
Opengraph URL: https://github.com/python/cpython/issues/95273
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Improve the sqlite3 reference","articleBody":"Improve the sqlite3 reference, using [Diataxis as a guideline](https://diataxis.fr/reference/). A lot of work has already been done here, with great help from Alex Waygood and CAM Gerlach. PRs so far[^1] have focused on...:\r\n\r\n- [Be accurate](https://diataxis.fr/reference/#be-accurate)\r\n- [Do nothing but describe](https://diataxis.fr/reference/#do-nothing-but-describe); making the wording more to the point\r\n\r\n\u003cdetails\u003e\r\n\u003csummary\u003ePrevious work over the last few years\u003c/summary\u003e\r\n\r\nBoth of these have been improved greatly by the following issues and PRs, amongst others:\r\n- gh-94630\r\n- gh-95235\r\n- gh-95235\r\n- gh-94940\r\n- gh-94321\r\n- gh-94628\r\n- gh-94017\r\n- gh-93890\r\n- gh-93925\r\n- gh-87260\r\n- gh-89018\r\n- gh-92780\r\n- gh-90923\r\n- gh-30660\r\n- gh-29326\r\n- gh-29200\r\n- gh-29219\r\n- gh-28238\r\n- gh-26220\r\n- gh-25003\r\n- gh-23159\r\n- gh-23965\r\n- consistency: gh-31772\r\n- consistency: gh-24746\r\n\r\n\u003c/details\u003e\r\n\r\nThere are remaining issues, though:\r\n\r\n- [x] Be accurate:\r\n - #95379\r\n - #95523\r\n - #95530\r\n- [x] [Be consistent](https://diataxis.fr/reference/#be-consistent): Most of the reference docs for sqlite3 functions and methods use the imperative mood. Some of the methods use other wordings. Suggesting to normalise, and use the imperative mood across the reference section.\r\n Improved with:\r\n - #95274 \r\n - #95525\r\n - Remove duplicate links\r\n- [x] [Respect the structure of the machinery](https://diataxis.fr/reference/#respect-the-structure-of-the-machinery): Arrange the sections of reference to follow the architecture of the module. This is pretty good already, but I believe we may benefit from some adjustments, in particular:\r\n - [x] Consistently group attributes and methods\r\n - #95626\r\n - #95430\r\n - Align wording in function and method docstrings with documentation\r\n- [x] [Do nothing but describe](https://diataxis.fr/reference/#do-nothing-but-describe): Avoid digressions and discussions, or even better, extract them to separate sections. Remove and or simplify examples.\r\n - #95351\r\n - #95383\r\n - gh-95840\r\n\r\n[^1]: There have been too many PRs to list; some of them were done before Diataxis was even discussed.","author":{"url":"https://github.com/erlend-aasland","@type":"Person","name":"erlend-aasland"},"datePublished":"2022-07-26T10:38:24.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/95273/cpython/issues/95273"}
| 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:93e56b44-e810-8bd9-fc97-c915b994caad |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8A12:25C52D:710B33:922062:696B148A |
| html-safe-nonce | 7292543ce3a6f161a61fab0e63495c88be2cda80aabf9ef407d69ae35075c624 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QTEyOjI1QzUyRDo3MTBCMzM6OTIyMDYyOjY5NkIxNDhBIiwidmlzaXRvcl9pZCI6IjcwNzQzODk1Mjg2NDE0NzU3MjIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 667fe59f6af6b7731eb6f1e2b121a1dfab1f6b17b1510c7d16722488e85fb12d |
| hovercard-subject-tag | issue:1318044598 |
| 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/95273/issue_layout |
| twitter:image | https://opengraph.githubassets.com/7d5e2b08ad63e587558f40fc402e97f42ec5320ed0b929919c2cb1c2651a6089/python/cpython/issues/95273 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/7d5e2b08ad63e587558f40fc402e97f42ec5320ed0b929919c2cb1c2651a6089/python/cpython/issues/95273 |
| og:image:alt | Improve the sqlite3 reference, using Diataxis as a guideline. A lot of work has already been done here, with great help from Alex Waygood and CAM Gerlach. PRs so far1 have focused on...: Be accurat... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | erlend-aasland |
| hostname | github.com |
| expected-hostname | github.com |
| None | 5f99f7c1d70f01da5b93e5ca90303359738944d8ab470e396496262c66e60b8d |
| 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 | 82560a55c6b2054555076f46e683151ee28a19bc |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width