Description

erlend-aasland

opened on Feb 28, 2022

Issue body actions

BPO	46878
Nosy	@JelleZijlstra, @miss-islington, @erlend-aasland
PRs	bpo-46878: Purge 'non-standard' from sqlite3 docstrings #31612 [3.10] bpo-46878: Purge 'non-standard' from sqlite3 docstrings (GH-31612) #31753 [3.9] bpo-46878: Purge 'non-standard' from sqlite3 docstrings (GH-31612) #31754

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2022-02-28.10:50:28.210>
labels = ['3.11']
title = '[sqlite3] remove "non-standard" from docstrings'
updated_at = <Date 2022-03-08.15:31:12.521>
user = 'https://github.com/erlend-aasland'

bugs.python.org fields:

activity = <Date 2022-03-08.15:31:12.521>
actor = 'miss-islington'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = []
creation = <Date 2022-02-28.10:50:28.210>
creator = 'erlendaasland'
dependencies = []
files = []
hgrepos = []
issue_num = 46878
keywords = ['patch']
message_count = 5.0
messages = ['414186', '414203', '414720', '414759', '414760']
nosy_count = 3.0
nosy_names = ['JelleZijlstra', 'miss-islington', 'erlendaasland']
pr_nums = ['31612', '31753', '31754']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue46878'
versions = ['Python 3.11']

Activity

1. erlend-aasland commented on Feb 28, 2022

   

   erlend-aasland

   on Feb 28, 2022

   ContributorAuthor

   More actions

   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¹, and again in a more recent PR².

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

   Footnotes

   1. https://github.com/python/cpython/pull/28463#discussion_r724371832 ↩

   2. https://github.com/python/cpython/pull/26728#discussion_r815523101 ↩
2. erlend-aasland

   added

   3.11only security fixesonly security fixes

   on Feb 28, 2022
3. JelleZijlstra commented on Feb 28, 2022

   

   JelleZijlstra

   on Feb 28, 2022

   Member

   More actions

   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.
4. JelleZijlstra commented on Mar 8, 2022

   

   JelleZijlstra

   on Mar 8, 2022

   Member

   More actions

   New changeset 4d95fa1 by Erlend Egeberg Aasland in branch 'main':
   bpo-46878: Purge 'non-standard' from sqlite3 docstrings (GH-31612)
   4d95fa1
5. miss-islington commented on Mar 8, 2022

   

   miss-islington

   on Mar 8, 2022

   Contributor

   More actions

   New changeset f3d3b2d by Erlend Egeberg Aasland in branch '3.10':
   [3.10] bpo-46878: Purge 'non-standard' from sqlite3 docstrings (GH-31612) (GH-31753)
   f3d3b2d
6. miss-islington commented on Mar 8, 2022

   

   miss-islington

   on Mar 8, 2022

   Contributor

   More actions

   New changeset 653ca6c by Erlend Egeberg Aasland in branch '3.9':
   [3.9] bpo-46878: Purge 'non-standard' from sqlite3 docstrings (GH-31612) (GH-31754)
   653ca6c
7. ezio-melotti

   transferred this issue fromon Apr 10, 2022
8. erlend-aasland

   closed this as completedon Apr 17, 2022
9. erlend-aasland

   added

   topic-sqlite3

   on May 16, 2022

Issue actions