gh-94635: Add Reference, How-to, and Concepts headings to sqlite3 docs by erlend-aasland · Pull Request #94636 · python/cpython

erlend-aasland · 2022-07-06T23:40:55Z

Issue: Restructure the sqlite3 docs table-of-contents #94635

CAM-Gerlach

Looks good overall; just a few comments.

erlend-aasland · 2022-07-07T20:17:51Z

Thanks for the review, CAM. My first impression when reading the review comments is that this PR is premature; we want to improve the wording in headings, and possibly move around some sections in separate PRs first.

ezio-melotti

A step in the right direction!

erlend-aasland · 2022-07-27T14:10:33Z

All right, I think this is ready for another round of reviews. I've already added the Introduction and Tutorial headings in a separate PR. For this PR, I restrict it to:

Adding top-level Reference, How-to guides, and Concepts headings, and simply rearrange the existing subsections below these
Normalise heading capitalisation.

Saved for later:

Possibly reword headings (the other draft PR)
Possibly split adapter/converter recipes section

CAM-Gerlach

A few minor textual suggestions, otherwise LGTM, thanks

CAM-Gerlach

Just a couple minor followups, otherwise LGTM, thanks

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

erlend-aasland · 2022-07-29T06:23:51Z

Thanks for the reviews! I'll let this sit around for some more days before merging, to give @ezio-melotti a chance to review the final changes.

CAM-Gerlach

LGTM on my end, thanks @erlend-aasland

erlend-aasland · 2022-07-30T23:23:51Z

Thanks for the reviews, CAM and Ezio!

miss-islington · 2022-07-30T23:24:18Z

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

miss-islington · 2022-07-30T23:24:28Z

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 6c439b978bf55b29f21c595e9375202d63c8208d 3.11

miss-islington · 2022-07-30T23:24:30Z

Sorry @erlend-aasland, I had trouble checking out the 3.10 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 6c439b978bf55b29f21c595e9375202d63c8208d 3.10

…o sqlite3 docs (pythonGH-94636) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 6c439b9) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>

bedevere-bot · 2022-07-30T23:36:27Z

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

bedevere-bot · 2022-07-30T23:38:05Z

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

…o sqlite3 docs (pythonGH-94636) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 6c439b9) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>

…qlite3 docs (GH-94636) (#95482) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 6c439b9) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com> * Fix refs

…qlite3 docs (GH-94636) (#95483) Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>. (cherry picked from commit 6c439b9) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com> * Fix refs

erlend-aasland requested a review from berkerpeksag as a code owner July 6, 2022 23:40

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

erlend-aasland linked an issue Jul 6, 2022 that may be closed by this pull request
Restructure the sqlite3 docs table-of-contents #94635
Closed

erlend-aasland force-pushed the sqlite-diataxis branch from 841d158 to 9c94eedCompare July 6, 2022 23:41

erlend-aasland added the skip news label Jul 6, 2022

erlend-aasland requested review from AA-Turner and CAM-Gerlach July 6, 2022 23:44

pythongh-94635: Reorder sqlite3 docs a la Diátaxis
05e4c21

erlend-aasland force-pushed the sqlite-diataxis branch from 9c94eed to 05e4c21Compare July 6, 2022 23:46

CAM-Gerlach reviewed Jul 7, 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

erlend-aasland marked this pull request as draft July 7, 2022 20:11

erlend-aasland added the DO-NOT-MERGE label Jul 7, 2022

ezio-melotti reviewed Jul 7, 2022
View reviewed changes

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

erlend-aasland mentioned this pull request Jul 7, 2022
Restructure the sqlite3 docs table-of-contents #94635
Closed

erlend-aasland mentioned this pull request Jul 26, 2022
gh-94635: Add sqlite3 'Introduction' and 'Tutorial' doc headings #95269
Merged

erlend-aasland added 3 commits July 27, 2022 14:39

Address reviews
3ed9049

Syntax fix
175f823

How-to guides a la diataxis
dbc4079

erlend-aasland removed the DO-NOT-MERGE label Jul 27, 2022

erlend-aasland marked this pull request as ready for review July 27, 2022 14:06

erlend-aasland requested review from CAM-Gerlach and ezio-melotti July 27, 2022 14:06

erlend-aasland changed the title ~~gh-94635: Reorder sqlite3 docs a la Diátaxis~~gh-94635: Add Reference, How-to, and Concepts headings to sqlite3 docsJul 27, 2022

CAM-Gerlach reviewed Jul 28, 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

Partially adress CAM's review
c529b7f

CAM-Gerlach reviewed Jul 29, 2022
View reviewed changes

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

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

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

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

ezio-melotti approved these changes Jul 30, 2022
View reviewed changes

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

bedevere-bot added awaiting merge and removed awaiting core review labels Jul 30, 2022

Erlend Egeberg Aaslandand others added 3 commits July 30, 2022 23:32

Don't link to the module inside the module docs
d53d11d

Merge remote-tracking branch 'upstream/main' into sqlite-diataxis
12854e1

Fix merge
56e0139

erlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Jul 30, 2022

erlend-aasland merged commit 6c439b9 into python:mainJul 30, 2022

bedevere-bot removed the awaiting merge label Jul 30, 2022

erlend-aasland deleted the sqlite-diataxis branch July 30, 2022 23:24

miss-islington assigned erlend-aasland Jul 30, 2022

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

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

ezio-melotti mentioned this pull request Jul 31, 2022
Style guide suggestion: Avoid duplicate links python/docs-community#52
Closed

CAM-Gerlach reviewed Jul 31, 2022
View reviewed changes

Comment threadDoc/library/sqlite3.rst

CAM-Gerlach mentioned this pull request Aug 3, 2022
Clarify best practices with ref target labels in docs python/devguide#927
Open

Uh oh!

Uh oh!

Conversation

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

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!

erlend-aasland commented Jul 7, 2022

Uh oh!

ezio-melotti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Jul 27, 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!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Jul 29, 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 30, 2022

Uh oh!

miss-islington commented Jul 30, 2022

Uh oh!

miss-islington commented Jul 30, 2022

Uh oh!

miss-islington commented Jul 30, 2022

Uh oh!

bedevere-bot commented Jul 30, 2022

Uh oh!

bedevere-bot commented Jul 30, 2022

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

erlend-aasland commented Jul 6, 2022•
edited by bedevere-bot
Loading