GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-95273: Reorganize sqlite3 doc module level funcs and vars by erlend-aasland · Pull Request #95626 · python/cpython

Conversation

@erlend-aasland

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CAM-Gerlach reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@erlend-aasland
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
erlend-aasland requested a review from berkerpeksag as a code owner August 3, 2022 21:20
@erlend-aasland erlend-aasland added needs backport to 3.10 needs backport to 3.11 only security fixes labels Aug 3, 2022
@erlend-aasland
erlend-aasland requested review from CAM-Gerlach and ezio-melotti August 3, 2022 21:20
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news awaiting core review labels Aug 3, 2022
@erlend-aasland erlend-aasland mentioned this pull request Aug 3, 2022
Improve the sqlite3 reference #95273
Closed
5 tasks done
@erlend-aasland

erlend-aasland commented Aug 3, 2022

Copy link
Copy Markdown
Contributor Author

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_statement1

Footnotes

  1. ... 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 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CAM-Gerlach
CAM-Gerlach requested changes Aug 3, 2022
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
ezio-melotti
ezio-melotti reviewed Aug 3, 2022
View reviewed changes

@ezio-melotti ezio-melotti left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
erlend-aasland added 2 commits August 4, 2022 21:05
@erlend-aasland
Address review: fix formatting
a3bb1bb
@erlend-aasland
Address review: split module level stuff into two subsubsections
c4036fd
ezio-melotti
ezio-melotti approved these changes Aug 4, 2022
View reviewed changes

@ezio-melotti ezio-melotti left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
erlend-aasland reacted with hooray emoji
All reactions
  • 🎉 1 reaction
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Aug 4, 2022
@ezio-melotti ezio-melotti mentioned this pull request Aug 4, 2022
gh-95271: Extract placeholders howto from sqlite3 tutorial #95522
Merged
Erlend Egeberg Aasland @ezio-melotti
Update Doc/library/sqlite3.rst
7a25c11 
Co-authored-by: Ezio Melotti <[email protected]>
@erlend-aasland
erlend-aasland requested a review from CAM-Gerlach August 4, 2022 20:20
@erlend-aasland 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 attrs Aug 4, 2022
@erlend-aasland erlend-aasland changed the title gh-95273: Reorganize sqlite3 doc module level funcs and attrs gh-95273: Reorganize sqlite3 doc module level funcs and variables Aug 4, 2022
@erlend-aasland erlend-aasland changed the title gh-95273: Reorganize sqlite3 doc module level funcs and variables gh-95273: Reorganize sqlite3 doc module level funcs and vars Aug 4, 2022
CAM-Gerlach
CAM-Gerlach approved these changes Aug 5, 2022
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a couple tiny nits.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Erlend Egeberg Aasland and others added 5 commits August 5, 2022 08:22
Erlend Egeberg Aasland @CAM-Gerlach
Update Doc/library/sqlite3.rst
3f8f0a6 
Co-authored-by: CAM Gerlach <[email protected]>
Erlend Egeberg Aasland @CAM-Gerlach
Update Doc/library/sqlite3.rst
dba48f4 
Co-authored-by: CAM Gerlach <[email protected]>
@erlend-aasland
Sync with main
a5e8019
@erlend-aasland
Module variables => Module constants
3c3bc79
@erlend-aasland
Fixup merge
8f1f102
@erlend-aasland
Facepalm
b5f6805
@erlend-aasland
erlend-aasland requested review from CAM-Gerlach and ezio-melotti August 6, 2022 19:24
ezio-melotti
ezio-melotti approved these changes Aug 6, 2022
View reviewed changes

@ezio-melotti ezio-melotti left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last suggestion, but otherwise LGTM.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@erlend-aasland
erlend-aasland merged commit 41c939c into python:main Aug 8, 2022
@miss-islington

miss-islington commented Aug 8, 2022

Copy link
Copy Markdown
Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the awaiting merge label Aug 8, 2022
@miss-islington

miss-islington commented Aug 8, 2022

Copy link
Copy Markdown
Contributor

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@erlend-aasland
erlend-aasland deleted the sqlite-reference/structure/module-level-stuff branch August 8, 2022 19:25
@miss-islington miss-islington assigned erlend-aasland Aug 8, 2022
@miss-islington

miss-islington commented Aug 8, 2022

Copy link
Copy Markdown
Contributor

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 8, 2022
@erlend-aasland
[3.11] pythongh-95273: Reorganize sqlite3 doc module level funcs and …
2e1a1c6 
…vars (pythonGH-95626)

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: CAM Gerlach <[email protected]>.
(cherry picked from commit 41c939c)

Co-authored-by: Erlend E. Aasland <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 8, 2022
@bedevere-bot

bedevere-bot commented Aug 8, 2022

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 8, 2022
@erlend-aasland
[3.10] pythongh-95273: Reorganize sqlite3 doc module level funcs and …
5688dc2 
…vars (pythonGH-95626)

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: CAM Gerlach <[email protected]>.
(cherry picked from commit 41c939c)

Co-authored-by: Erlend E. Aasland <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 label Aug 8, 2022
@bedevere-bot

bedevere-bot commented Aug 8, 2022

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
erlend-aasland added a commit that referenced this pull request Aug 8, 2022
@erlend-aasland
[3.10] gh-95273: Reorganize sqlite3 doc module level funcs and vars (G…
49e505c 
…H-95626) (#95803)

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: CAM Gerlach <[email protected]>.
(cherry picked from commit 41c939c)

Co-authored-by: Erlend E. Aasland <[email protected]>
erlend-aasland added a commit that referenced this pull request Aug 9, 2022
@erlend-aasland
[3.11] gh-95273: Reorganize sqlite3 doc module level funcs and vars (G…
d7a6a97 
…H-95626) (#95801)

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: CAM Gerlach <[email protected]>.
(cherry picked from commit 41c939c)

Co-authored-by: Erlend E. Aasland <[email protected]>
iritkatriel pushed a commit to iritkatriel/cpython that referenced this pull request Aug 11, 2022
@erlend-aasland @ezio-melotti
@CAM-Gerlach @iritkatriel
pythongh-95273: Reorganize sqlite3 doc module level funcs and vars (p…
37d7645 
…ython#95626)

Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: CAM Gerlach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ezio-melotti ezio-melotti ezio-melotti approved these changes
@berkerpeksag berkerpeksag Awaiting requested review from berkerpeksag
@CAM-Gerlach CAM-Gerlach Awaiting requested review from CAM-Gerlach

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@erlend-aasland erlend-aasland

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@erlend-aasland @miss-islington @bedevere-bot @CAM-Gerlach @ezio-melotti
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.