Repository navigation
Improve the sqlite3 reference #95273
Copy link
Copy link
Closed
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dirtriagedThe issue has been accepted as valid by a triager.The issue has been accepted as valid by a triager.
Description
Activity
- addeddocsDocumentation in the Doc dirDocumentation in the Doc dirtriagedThe issue has been accepted as valid by a triager.The issue has been accepted as valid by a triager.
on Jul 26, 2022 - changed the title
[-]Normalise wording of sqlite3 function and method docs[/-][+]Normalise sqlite3 reference doc wording[/+]on Jul 26, 2022 - added a commit that references this issue
on Jul 26, 2022 - changed the title
[-]Normalise sqlite3 reference doc wording[/-][+]Improve the sqlite3 reference[/+]on Jul 27, 2022 - added a commit that references this issue
on Jul 27, 2022 - added 4 commits that reference this issue
on Jul 27, 2022 51 remaining items
- added 5 commits that reference this issue
on Aug 8, 2022 - added 5 commits that reference this issue
on Aug 11, 2022 I'm going to close this issue:
- it is close to impossible to say when such a meta-issue can be closed as it's goal is a moving target
- most of the issues pointed out have been fixed
Further work can be done either without PRs (moving a section, minor rewordings, etc.) or with better targeted issues.
A big thanks to Alex, CAM, and Ezio, who have been helping out by improving the quality of the changes considerably. Thank you so much!
Reacted by Ezio MelottiReacted by Alex WaygoodReacted by Alex Waygood
Metadata
Metadata
Assignees
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dirtriagedThe issue has been accepted as valid by a triager.The issue has been accepted as valid by a triager.
Projects
- StatusShow more project fieldsDone
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...:
Previous work over the last few years
Both of these have been improved greatly by the following issues and PRs, amongst others:
Connection.create_collation()documentation inaccuracies #92780sqlite3docs #30660sqlite3docs #29326sqlite3docs about "timestamp" converter #29200sqlite3DB-API attributes and methods #29219sqlite3trace callback docs #28238There are remaining issues, though:
Improved with:
Footnotes
There have been too many PRs to list; some of them were done before Diataxis was even discussed. ↩