gh-94017: Improve clarity of sqlite3 transaction handling docs by erlend-aasland · Pull Request #94320 · python/cpython

erlend-aasland · 2022-06-27T08:52:27Z

erlend-aasland · 2022-06-27T08:56:42Z

cc. @CAM-Gerlach, @AlexWaygood. Would you two mind reviewing this? I'll go over it later today, to be sure the docs align with the actual implementation. Other that, I worry that the new tone of the docs may come across as ... perhaps a trifle strict, or negative sounding (in lack of more appropriate words). I also worry about the added verbosity. I do hope this makes things clearer, though.

…ite-doc-tx-handling

… the underlying library

CAM-Gerlach

Thanks @erlend-aasland , this is a definite improvement. I do have some clarity, textual and reST fixes and suggestions.

AlexWaygood

+1 to most of Cam's thoughts

erlend-aasland · 2022-07-01T20:57:01Z

Thanks, both of you; highly appreciated. I'm finally getting around to address the reviews.

erlend-aasland · 2022-07-01T21:51:07Z

Reviews addressed in a530b3e.
I mostly went for ~Connection.isolation_level style links instead of the more explicit Connection.isolation_level style links. I can use the latter if that's preferred.

CAM-Gerlach · 2022-07-02T02:46:04Z

I mostly went for ~Connection.isolation_level style links instead of the more explicit Connection.isolation_level style links. I can use the latter if that's preferred.

That's fine with me, since it isn't used on multiple classes in the module and links directly to them in either case. I wasn't very consistent about using that myself.

CAM-Gerlach

LGTM, thanks @erlend-aasland

I had one comment, but that might be out of scope here and better addressed in a future PR.

erlend-aasland · 2022-07-03T21:03:17Z

I'm sorry, but I did a last rewrite of things, trying to address #94320 (comment). Hopefully to the better. I'd be happy if you could review commit 1473e94. If it was for the worse, I'll revert it.

For the "Controlling Transactions" section, I tried to improve the visual separation of the two sqlite3 transaction modes.

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

CAM-Gerlach · 2022-07-05T23:55:24Z

I'm sorry, but I did a last rewrite of things, trying to address #94320 (comment). Hopefully to the better. I'd be happy if you could review commit 1473e94. If it was for the worse, I'll revert it.

No need to apologize for doing more work and making the docs better! I'll review it now—sorry myself for the delay; it was a holiday weekend and I was with family.

CAM-Gerlach

Review feedback on the final revisisions

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

erlend-aasland · 2022-07-06T20:44:22Z

Thanks again for the reviews; I'll land this later tonight.

miss-islington · 2022-07-06T20:59:10Z

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

…ythonGH-94320) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit 760b8cf) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

bedevere-bot · 2022-07-06T20:59:31Z

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

…ythonGH-94320) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit 760b8cf) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

bedevere-bot · 2022-07-06T20:59:36Z

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

) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit 760b8cf) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

pythongh-94017: Improve clarity of sqlite3 transaction handling docs
91460c0

erlend-aasland requested a review from berkerpeksag as a code owner June 27, 2022 08:52

bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jun 27, 2022

erlend-aasland added the DO-NOT-MERGE label Jun 27, 2022

AlexWaygood self-requested a review June 27, 2022 09:01

Incorporate additional changes frompythongh-93823
a531aa8

erlend-aasland commented Jun 27, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated

AlexWaygood added the skip news label Jun 27, 2022

erlend-aasland commented Jun 27, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated

Erlend Egeberg Aaslandand others added 4 commits June 28, 2022 01:25

Update Doc/library/sqlite3.rst
b09fab1

Adjust wording
f9f4f97

Merge remote-tracking branch 'origin/sqlite-doc-tx-handling' into sql…
80d29aa
…ite-doc-tx-handling

Make it clearer that SQLite autocommit mode is a concept belonging to…
576c760
… the underlying library

CAM-Gerlach reviewed Jun 30, 2022
View reviewed changes

AlexWaygood reviewed Jul 1, 2022
View reviewed changes

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

Address reviews
a530b3e

CAM-Gerlach approved these changes Jul 2, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst

erlend-aasland commented Jul 2, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated

Last rewrite, I promise
1473e94

AlexWaygood reviewed Jul 3, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst Outdated

Typo
7aa11d5
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

CAM-Gerlach reviewed Jul 6, 2022
View reviewed changes

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

Address most of CAM's review
7418668

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

erlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes and removed DO-NOT-MERGE labels Jul 6, 2022

erlend-aasland merged commit 760b8cf into python:mainJul 6, 2022

bedevere-bot removed the awaiting core review label Jul 6, 2022

erlend-aasland deleted the sqlite-doc-tx-handling branch July 6, 2022 20:59

bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 6, 2022

bedevere-bot removed the needs backport to 3.10 only security fixes label Jul 6, 2022

erlend-aasland mentioned this pull request Jul 6, 2022
Improve clarity of sqlite3 transaction handling docs #94017
Closed

erlend-aasland mentioned this pull request Jul 25, 2022
Document all parameters of all sqlite3 functions/methods #95235
Closed

Uh oh!

Uh oh!

Conversation

erlend-aasland commented Jun 27, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erlend-aasland commented Jun 27, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AlexWaygood left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Jul 1, 2022

Uh oh!

erlend-aasland commented Jul 1, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CAM-Gerlach commented Jul 2, 2022

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

CAM-Gerlach commented Jul 5, 2022

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Jul 6, 2022

Uh oh!

miss-islington commented Jul 6, 2022

Uh oh!

bedevere-bot commented Jul 6, 2022

Uh oh!

bedevere-bot commented Jul 6, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

erlend-aasland commented Jun 27, 2022•
edited
Loading

erlend-aasland commented Jun 27, 2022•
edited
Loading

erlend-aasland commented Jul 1, 2022•
edited
Loading

erlend-aasland commented Jul 3, 2022•
edited
Loading