gh-95273: Reorganize sqlite3 doc module level funcs and vars by erlend-aasland · Pull Request #95626 · python/cpython

erlend-aasland · 2022-08-03T21:20:14Z

Put module level functions before module level attributes, and (mostly)
sort them alphabetically. This makes sqlite3.connect() the first
encounter in the sqlite3 reference.

Issue: Improve the sqlite3 reference #95273

Put module level functions before module level attributes, and (mostly) sort them alphabetically. This makes sqlite3.connect() the first encounter in the sqlite3 reference.

erlend-aasland · 2022-08-03T21:25:16Z

Other things to note, aside of the nice sqlite3.connect promotion:

sqlite3.version* is now at the end; that's ok, since they're confusing to people, and they are deprecated :)
it's almost alphabetically sorted, but we cannot start with the obscure sqlite3.complete_statement¹

... which has a far too large example for being such an obscure function; IMO, we can remove that example (or at least greatly simplify it), or maybe just point to the source code of the newly added sqlite3 CLI. ↩

CAM-Gerlach

Great idea overall, this is certainly a significant improvement. There is one serious syntax issue that needs to be fixed, and I wonder whether it might be a better idea to split the module-level constants and functions into two separate sections for clarity.

ezio-melotti

The changes LGTM, assuming you just moved things around and wrapped a few long lines.

ezio-melotti

A small inconsequential nit, otherwise LGTM.
I've seen refs without spaces elsewhere, so you might want to double-check the whole file, possibly in a separate PR (perhaps together with adding ! to `:mod:`sqlite3`).

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

CAM-Gerlach

LGTM, just a couple tiny nits.

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>

ezio-melotti

One last suggestion, but otherwise LGTM.

miss-islington · 2022-08-08T19:25:39Z

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

miss-islington · 2022-08-08T19:25:41Z

Sorry, @erlend-aasland, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 41c939cb35cda395388a775156c367676efffebe 3.11

miss-islington · 2022-08-08T19:25:45Z

Sorry, @erlend-aasland, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 41c939cb35cda395388a775156c367676efffebe 3.10

…vars (pythonGH-95626) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 41c939c) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

bedevere-bot · 2022-08-08T19:39:48Z

GH-95801 is a backport of this pull request to the 3.11 branch.

…vars (pythonGH-95626) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 41c939c) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

bedevere-bot · 2022-08-08T19:49:41Z

GH-95803 is a backport of this pull request to the 3.10 branch.

…H-95626) (#95803) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 41c939c) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

…H-95626) (#95801) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 41c939c) Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

…ython#95626) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>

pythongh-95273: Re-organize sqlite3 doc module level funcs and attrs
7452815
Put module level functions before module level attributes, and (mostly) sort them alphabetically. This makes sqlite3.connect() the first encounter in the sqlite3 reference.

erlend-aasland requested a review from berkerpeksag as a code owner August 3, 2022 21:20

erlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Aug 3, 2022

erlend-aasland requested review from CAM-Gerlach and ezio-melotti August 3, 2022 21:20

bedevere-bot added docs Documentation in the Doc dir skip news awaiting core review labels Aug 3, 2022

erlend-aasland mentioned this pull request Aug 3, 2022
Improve the sqlite3 reference #95273
Closed
5 tasks

CAM-Gerlach requested changes Aug 3, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/sqlite3.rst Outdated

ezio-melotti reviewed Aug 3, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst

erlend-aasland added 2 commits August 4, 2022 21:05

Address review: fix formatting
a3bb1bb

Address review: split module level stuff into two subsubsections
c4036fd

ezio-melotti approved these changes Aug 4, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated

bedevere-bot added awaiting merge and removed awaiting core review labels Aug 4, 2022

ezio-melotti mentioned this pull request Aug 4, 2022
gh-95271: Extract placeholders howto from sqlite3 tutorial #95522
Merged

Update Doc/library/sqlite3.rst
7a25c11
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

erlend-aasland requested a review from CAM-Gerlach August 4, 2022 20:20

erlend-aasland changed the title ~~gh-95273: Re-organize sqlite3 doc module level funcs and attrs~~gh-95273: Reorganize sqlite3 doc module level funcs and attrsAug 4, 2022

erlend-aasland changed the title ~~gh-95273: Reorganize sqlite3 doc module level funcs and attrs~~gh-95273: Reorganize sqlite3 doc module level funcs and variablesAug 4, 2022

erlend-aasland changed the title ~~gh-95273: Reorganize sqlite3 doc module level funcs and variables~~gh-95273: Reorganize sqlite3 doc module level funcs and varsAug 4, 2022

CAM-Gerlach approved these changes Aug 5, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst
Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/sqlite3.rst

Erlend Egeberg Aaslandand others added 5 commits August 5, 2022 08:22

Update Doc/library/sqlite3.rst
3f8f0a6
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>

Update Doc/library/sqlite3.rst
dba48f4
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>

Sync with main
a5e8019

Module variables => Module constants
3c3bc79

Fixup merge
8f1f102

Facepalm
b5f6805

erlend-aasland requested review from CAM-Gerlach and ezio-melotti August 6, 2022 19:24

ezio-melotti approved these changes Aug 6, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst

erlend-aasland merged commit 41c939c into python:mainAug 8, 2022

bedevere-bot removed the awaiting merge label Aug 8, 2022

erlend-aasland deleted the sqlite-reference/structure/module-level-stuff branch August 8, 2022 19:25

miss-islington assigned erlend-aasland Aug 8, 2022

bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 8, 2022

bedevere-bot removed the needs backport to 3.10 only security fixes label Aug 8, 2022

Uh oh!

Uh oh!

Conversation

erlend-aasland commented Aug 3, 2022• edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erlend-aasland commented Aug 3, 2022

Footnotes

Uh oh!

CAM-Gerlach left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ezio-melotti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ezio-melotti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ezio-melotti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington commented Aug 8, 2022

Uh oh!

miss-islington commented Aug 8, 2022

Uh oh!

miss-islington commented Aug 8, 2022

Uh oh!

bedevere-bot commented Aug 8, 2022

Uh oh!

bedevere-bot commented Aug 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

erlend-aasland commented Aug 3, 2022•
edited by bedevere-bot
Loading

CAM-Gerlach left a comment •
edited
Loading