[docs] [issue15067] Clean up the sqlite3 docs

Zachary Ware report at bugs.python.org
Thu Nov 1 20:06:06 CET 2012

Zachary Ware added the comment:

Coming back to this 5 months later and looking into it myself, I find that the sqlite3 docs really need a bit of a cleanup all around, especially in all three 3.x branches.  Several minor changes were made by Raymond Hettinger in d229032dc213 and a few subsequent changesets 6 months ago in the 2.7 branch, but none of those ever made it to 3.x. (Raymond, those changes in the past are why I made you nosy on this one)

To address the offending sentence that brought this issue about in the first place, after rereading it and thinking about it some more, what's there does make sense: this module uses the recipe of PEP 246, regardless of that PEP's status.  However, I don't think it's helpful to mention it in the documentation, as it kind of gives the impression that "this feature was rejected for the whole of Python, but this stdlib module goes ahead and does it anyway."  For that reason, I propose to just drop that two-line paragraph entirely.  Everything about that feature still makes sense without that paragraph, even though the 'protocol' bit seems a bit weird. I wonder though, should that feature be deprecated on the basis of using a rejected PEP as well as TOOWTDI violation (or should I open another issue to that effect anyway)?

In the same vein as Raymond's earlier 2.7 changes (namely the SQL cleanup and capitalization he did), the 2.7 patch I've attached goes through and does the same for all of the included scripts in Doc/includes/sqlite3 as well as removing the bit about PEP 246.

The 3.2 patch does everything in the 2.7 patch, plus bringing the 3.2 docs in line with the 2.7 docs.

I do have a question, though; the footnote about enabling loadable extensions is different in the 2.7 and 3.2 docs.  Which one is right, or are both right for their respective versions?



keywords: +patch
nosy: +rhettinger
title: sqlite3 docs reference PEP 246, which was rejected -> Clean up the sqlite3 docs
versions: +Python 3.4
Added file: http://bugs.python.org/file27829/sqlite3_cleanup_2.7.patch

Python tracker <report at bugs.python.org>

More information about the docs mailing list