Skip to content

Docs: group sqlite3.Connection attributes and methods #96090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2022

Conversation

erlend-aasland
Copy link
Contributor

No description provided.

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

IMO, it makes sense to list attributes before methods as you do, but just to note, the Cursor class right below it has the opposite order. Given it should be consistent (especially in Reference documentation), do you plan to follow this up with a PR moving those as well? Or would you like me to?

@erlend-aasland
Copy link
Contributor Author

Given it should be consistent (especially in Reference documentation), do you plan to follow this up with a PR moving those as well? Or would you like me to?

Yes, I noticed. Consistency is a good thing. Feel free to submit a PR for that.

@erlend-aasland erlend-aasland merged commit 1a140af into python:main Aug 19, 2022
@miss-islington
Copy link
Contributor

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

@erlend-aasland
Copy link
Contributor Author

Thanks for the reviews!

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 19, 2022
@bedevere-bot
Copy link

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

@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 19, 2022
(cherry picked from commit 1a140af)

Co-authored-by: Erlend E. Aasland <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Aug 19, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 19, 2022
(cherry picked from commit 1a140af)

Co-authored-by: Erlend E. Aasland <[email protected]>
miss-islington added a commit that referenced this pull request Aug 19, 2022
(cherry picked from commit 1a140af)

Co-authored-by: Erlend E. Aasland <[email protected]>
miss-islington added a commit that referenced this pull request Aug 19, 2022
(cherry picked from commit 1a140af)

Co-authored-by: Erlend E. Aasland <[email protected]>
@erlend-aasland
Copy link
Contributor Author

Reading through the docs in their current form, I wonder if it was a mistake to put the connection attributes before the connection methods; for your everyday sqlite3 programming, I suspect you'll be using the connection methods way more often than you'll be using the connection attributes. I think we should consider putting the methods before the attributes.

@CAM-Gerlach
Copy link
Member

Yeah, I'd prepped a PR to do the above a few weeks ago when we discussed it, but got second thoughts for the same reason you mention and never went through with it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants