René's URL Explorer Experiment


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

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:93e56b44-e810-8bd9-fc97-c915b994caad
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id8A12:25C52D:710B33:922062:696B148A
html-safe-nonce7292543ce3a6f161a61fab0e63495c88be2cda80aabf9ef407d69ae35075c624
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QTEyOjI1QzUyRDo3MTBCMzM6OTIyMDYyOjY5NkIxNDhBIiwidmlzaXRvcl9pZCI6IjcwNzQzODk1Mjg2NDE0NzU3MjIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac667fe59f6af6b7731eb6f1e2b121a1dfab1f6b17b1510c7d16722488e85fb12d
hovercard-subject-tagissue:1318044598
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/cpython/95273/issue_layout
twitter:imagehttps://opengraph.githubassets.com/7d5e2b08ad63e587558f40fc402e97f42ec5320ed0b929919c2cb1c2651a6089/python/cpython/issues/95273
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/7d5e2b08ad63e587558f40fc402e97f42ec5320ed0b929919c2cb1c2651a6089/python/cpython/issues/95273
og:image:altImprove 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameerlend-aasland
hostnamegithub.com
expected-hostnamegithub.com
None5f99f7c1d70f01da5b93e5ca90303359738944d8ab470e396496262c66e60b8d
turbo-cache-controlno-preview
go-importgithub.com/python/cpython git https://github.com/python/cpython.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id81598961
octolytics-dimension-repository_nwopython/cpython
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id81598961
octolytics-dimension-repository_network_root_nwopython/cpython
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release82560a55c6b2054555076f46e683151ee28a19bc
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python/cpython/issues/95273#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fissues%2F95273
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fissues%2F95273
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python%2Fcpython
Reloadhttps://github.com/python/cpython/issues/95273
Reloadhttps://github.com/python/cpython/issues/95273
Reloadhttps://github.com/python/cpython/issues/95273
python https://github.com/python
cpythonhttps://github.com/python/cpython
Please reload this pagehttps://github.com/python/cpython/issues/95273
Notifications https://github.com/login?return_to=%2Fpython%2Fcpython
Fork 33.9k https://github.com/login?return_to=%2Fpython%2Fcpython
Star 71.1k https://github.com/login?return_to=%2Fpython%2Fcpython
Code https://github.com/python/cpython
Issues 5k+ https://github.com/python/cpython/issues
Pull requests 2.1k https://github.com/python/cpython/pulls
Actions https://github.com/python/cpython/actions
Projects 31 https://github.com/python/cpython/projects
Security Uh oh! There was an error while loading. Please reload this page. https://github.com/python/cpython/security
Please reload this pagehttps://github.com/python/cpython/issues/95273
Insights https://github.com/python/cpython/pulse
Code https://github.com/python/cpython
Issues https://github.com/python/cpython/issues
Pull requests https://github.com/python/cpython/pulls
Actions https://github.com/python/cpython/actions
Projects https://github.com/python/cpython/projects
Security https://github.com/python/cpython/security
Insights https://github.com/python/cpython/pulse
New issuehttps://github.com/login?return_to=https://github.com/python/cpython/issues/95273
New issuehttps://github.com/login?return_to=https://github.com/python/cpython/issues/95273
Improve the sqlite3 referencehttps://github.com/python/cpython/issues/95273#top
#95525https://github.com/python/cpython/pull/95525
https://github.com/erlend-aasland
docsDocumentation in the Doc dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22docs%22
triagedThe issue has been accepted as valid by a triager.https://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22triaged%22
https://github.com/erlend-aasland
https://github.com/erlend-aasland
erlend-aaslandhttps://github.com/erlend-aasland
on Jul 26, 2022https://github.com/python/cpython/issues/95273#issue-1318044598
Diataxis as a guidelinehttps://diataxis.fr/reference/
1https://github.com/python/cpython/issues/95273#user-content-fn-1-34154bf0d6f0fe666a376b14b13019e3
Be accuratehttps://diataxis.fr/reference/#be-accurate
Do nothing but describehttps://diataxis.fr/reference/#do-nothing-but-describe
Update sqlite3 docs with positional-only and keyword-only symbols #94630https://github.com/python/cpython/issues/94630
Document all parameters of all sqlite3 functions/methods #95235https://github.com/python/cpython/issues/95235
Document all parameters of all sqlite3 functions/methods #95235https://github.com/python/cpython/issues/95235
gh-81040: Improve sqlite3.Cursor.rowcount docs #94940https://github.com/python/cpython/pull/94940
Document sqlite3.PrepareProtocol #94321https://github.com/python/cpython/issues/94321
Doc: Add explicit parameter list to sqlite3.connect #94628https://github.com/python/cpython/issues/94628
Improve clarity of sqlite3 transaction handling docs #94017https://github.com/python/cpython/issues/94017
gh-61162: Clarify sqlite3 connection context manager docs #93890https://github.com/python/cpython/pull/93890
Improve docs/docstrings of sqlite3 commit()/rollback() and close() #93925https://github.com/python/cpython/issues/93925
sqlite3 signature discrepancies between documentation and implementation #87260https://github.com/python/cpython/issues/87260
[doc] Complete the sqlite3 exception documentation #89018https://github.com/python/cpython/issues/89018
sqlite3: Connection.create_collation() documentation inaccuracies #92780https://github.com/python/cpython/issues/92780
[Doc] sqlite3 Cursor.execute() return value is unspecified #90923https://github.com/python/cpython/issues/90923
bpo-46402: Promote SQLite URI tricks in sqlite3 docs #30660https://github.com/python/cpython/pull/30660
bpo-45677: Reword first section of sqlite3 docs #29326https://github.com/python/cpython/pull/29326
bpo-45335: Add note to sqlite3 docs about "timestamp" converter #29200https://github.com/python/cpython/pull/29200
bpo-45608: Document missing sqlite3 DB-API attributes and methods #29219https://github.com/python/cpython/pull/29219
bpo-45089: Improve sqlite3 trace callback docs #28238https://github.com/python/cpython/pull/28238
bpo-30593: Document that sqlite3.Cursor.executescript disregards isolation_level #26220https://github.com/python/cpython/pull/26220
bpo-20364: Improve sqlite3 placeholder docs #25003https://github.com/python/cpython/pull/25003
bpo-38413: Improve documentation of sqlite3 module #23159https://github.com/python/cpython/pull/23159
bpo-42755: Fix sqlite3.Connection.backup docs #23965https://github.com/python/cpython/pull/23965
Doc: normalise pre-acronym determiners #31772https://github.com/python/cpython/pull/31772
bpo-43396: normalise naming in sqlite3 doc examples #24746https://github.com/python/cpython/pull/24746
gh-95273: Improve sqlite3 class descriptions #95379https://github.com/python/cpython/pull/95379
gh-95273: Clarify when the sqlite_* attributes are added to sqlite3 exceptions #95523https://github.com/python/cpython/pull/95523
gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods #95530https://github.com/python/cpython/pull/95530
Be consistenthttps://diataxis.fr/reference/#be-consistent
gh-95273: Normalise sqlite3 reference wording #95274https://github.com/python/cpython/pull/95274
gh-95273: Align sqlite3 const refs with the devguide #95525https://github.com/python/cpython/pull/95525
Respect the structure of the machineryhttps://diataxis.fr/reference/#respect-the-structure-of-the-machinery
gh-95273: Reorganize sqlite3 doc module level funcs and vars #95626https://github.com/python/cpython/pull/95626
gh-95273: Relocate sqlite3 enable load extension note #95430https://github.com/python/cpython/pull/95430
Do nothing but describehttps://diataxis.fr/reference/#do-nothing-but-describe
gh-95273: Move sqlite3 executemany examples from reference to tutorial #95351https://github.com/python/cpython/pull/95351
gh-95273: Condense sqlite3 executescript example #95383https://github.com/python/cpython/pull/95383
gh-95273: Improve sqlite3.complete_statement docs #95840https://github.com/python/cpython/pull/95840
https://github.com/python/cpython/issues/95273#user-content-fnref-1-34154bf0d6f0fe666a376b14b13019e3
erlend-aaslandhttps://github.com/erlend-aasland
docsDocumentation in the Doc dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22docs%22
triagedThe issue has been accepted as valid by a triager.https://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22triaged%22
sqlite3 issueshttps://github.com/orgs/python/projects/23
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.