classification
Title: [doc] add sqlite3 module docstring
Type: Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, erlendaasland, lukasz.langa, miss-islington
Priority: normal Keywords: patch

Created on 2021-10-26 08:12 by erlendaasland, last changed 2021-10-28 20:25 by lukasz.langa. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 29224 merged erlendaasland, 2021-10-26 08:14
PR 29288 merged miss-islington, 2021-10-28 19:55
PR 29289 merged miss-islington, 2021-10-28 19:55
Messages (5)
msg405030 - (view) Author: Erlend E. Aasland (erlendaasland) * (Python triager) Date: 2021-10-26 08:12
Currently, the sqlite3 module docstring is the old pysqlite copyright comment in the start of Lib/sqlite3/__init__.py. This is not very helpful to the general user. Suggesting to add a more helpful docstring, a la the 're' or 'array' modules (those two were randomly picked among stdlib modules with helpful docstrings).
msg405245 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-10-28 19:55
New changeset 4dd1e84789f0bd2da83ad06d23c569bf03713a50 by Erlend Egeberg Aasland in branch 'main':
bpo-45612: Add sqlite3 module docstring (GH-29224)
https://github.com/python/cpython/commit/4dd1e84789f0bd2da83ad06d23c569bf03713a50
msg405262 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-10-28 20:25
New changeset 823b3e39ae12884d5aa3c98341a41b2d6f19d329 by Miss Islington (bot) in branch '3.10':
bpo-45612: Add sqlite3 module docstring (GH-29224) (GH-29288)
https://github.com/python/cpython/commit/823b3e39ae12884d5aa3c98341a41b2d6f19d329
msg405263 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-10-28 20:25
New changeset d6623c3ddb9a0e5ffed81253bd40f75c3c662f1a by Miss Islington (bot) in branch '3.9':
bpo-45612: Add sqlite3 module docstring (GH-29224) (GH-29289)
https://github.com/python/cpython/commit/d6623c3ddb9a0e5ffed81253bd40f75c3c662f1a
msg405264 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-10-28 20:25
Thanks, Erlend! ✨ 🍰 ✨
History
Date User Action Args
2021-10-28 20:25:57lukasz.langasetstatus: open -> closed
resolution: fixed
messages: + msg405264

stage: patch review -> resolved
2021-10-28 20:25:41lukasz.langasetmessages: + msg405263
2021-10-28 20:25:01lukasz.langasetmessages: + msg405262
2021-10-28 19:55:39miss-islingtonsetpull_requests: + pull_request27552
2021-10-28 19:55:36lukasz.langasetnosy: + lukasz.langa
messages: + msg405245
2021-10-28 19:55:35miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request27551
2021-10-26 08:14:44erlendaaslandsetkeywords: + patch
stage: patch review
pull_requests: + pull_request27488
2021-10-26 08:12:44erlendaaslandcreate