This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: [sqlite3] remove "non-standard" from docstrings
Type: Stage: patch review
Components: Versions: Python 3.11
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: JelleZijlstra, erlendaasland, miss-islington
Priority: normal Keywords: patch

Created on 2022-02-28 10:50 by erlendaasland, last changed 2022-04-11 14:59 by admin.

Pull Requests
URL Status Linked Edit
PR 31612 merged erlendaasland, 2022-02-28 10:53
PR 31753 closed erlendaasland, 2022-03-08 08:30
PR 31754 merged erlendaasland, 2022-03-08 08:31
Messages (5)
msg414186 - (view) Author: Erlend E. Aasland (erlendaasland) * (Python triager) Date: 2022-02-28 10:50
Several sqlite3 methods are "marked" as non-standard in their docstrings. This is an historic artefact which (I assume) implies that a method is not a part of the DB-API defined by PEP 249. Questions regarding the "non-standard" strings arise from time to time, as the meaning is not immediately obvious.

The question surfaced in a code review in October 2021[^1], and again in a more recent PR[^2].

Suggesting to purge "non-standard" from all docstrings once and for all to avoid more confusion.

[^1]: https://github.com/python/cpython/pull/28463#discussion_r724371832
[^2]: https://github.com/python/cpython/pull/26728#discussion_r815523101
msg414203 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2022-02-28 15:07
As one of the people confused by this wording, I agree with dropping it. There is no documentation that I can find that explains what "non-standard" means.

I'll leave the PR for some time though in case others have objections.
msg414720 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2022-03-08 04:18
New changeset 4d95fa1ac5d31ff450fb2f31b55ce1eb99d6efcb by Erlend Egeberg Aasland in branch 'main':
bpo-46878: Purge 'non-standard' from sqlite3 docstrings (GH-31612)
https://github.com/python/cpython/commit/4d95fa1ac5d31ff450fb2f31b55ce1eb99d6efcb
msg414759 - (view) Author: miss-islington (miss-islington) Date: 2022-03-08 15:30
New changeset f3d3b2d5c5599272660f4bbd5103aa8abc7c48c4 by Erlend Egeberg Aasland in branch '3.10':
[3.10] bpo-46878: Purge 'non-standard' from sqlite3 docstrings (GH-31612) (GH-31753)
https://github.com/python/cpython/commit/f3d3b2d5c5599272660f4bbd5103aa8abc7c48c4
msg414760 - (view) Author: miss-islington (miss-islington) Date: 2022-03-08 15:31
New changeset 653ca6c62b0c3272310f7fa5ce9c6939e3c41d91 by Erlend Egeberg Aasland in branch '3.9':
[3.9] bpo-46878: Purge 'non-standard' from sqlite3 docstrings (GH-31612) (GH-31754)
https://github.com/python/cpython/commit/653ca6c62b0c3272310f7fa5ce9c6939e3c41d91
History
Date User Action Args
2022-04-11 14:59:56adminsetgithub: 91034
2022-03-08 15:31:12miss-islingtonsetmessages: + msg414760
2022-03-08 15:30:25miss-islingtonsetnosy: + miss-islington
messages: + msg414759
2022-03-08 08:31:53erlendaaslandsetpull_requests: + pull_request29867
2022-03-08 08:30:26erlendaaslandsetpull_requests: + pull_request29866
2022-03-08 04:18:52JelleZijlstrasetmessages: + msg414720
2022-02-28 15:07:40JelleZijlstrasetmessages: + msg414203
2022-02-28 10:53:44erlendaaslandsetkeywords: + patch
stage: patch review
pull_requests: + pull_request29735
2022-02-28 10:50:28erlendaaslandcreate