Skip to content

gh-94635: Add Reference, How-to, and Concepts headings to sqlite3 docs#94636

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.

Sign up for GitHub

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

Jump to bottom
Merged
erlend-aasland merged 11 commits into from
Jul 30, 2022
Merged

gh-94635: Add Reference, How-to, and Concepts headings to sqlite3 docs #94636

erlend-aasland merged 11 commits into from
Jul 30, 2022

Conversation

@erlend-aasland
Copy link
Contributor

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

@bedevere-botbedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 6, 2022
@erlend-aaslanderlend-aasland linked an issue Jul 6, 2022 that may be closed by this pull request
Restructure the sqlite3 docs table-of-contents #94635
Closed
CAM-Gerlach
CAM-Gerlach reviewed Jul 7, 2022
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Looks good overall; just a few comments.

@erlend-aaslanderlend-aasland marked this pull request as draft July 7, 2022 20:11
@erlend-aasland
Copy link
ContributorAuthor

erlend-aasland commented Jul 7, 2022

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
ezio-melotti reviewed Jul 7, 2022
View reviewed changes
Copy link
Member

@ezio-melottiezio-melotti left a comment

Choose a reason for hiding this comment

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

A step in the right direction!

@erlend-aaslanderlend-aasland mentioned this pull request Jul 7, 2022
Closed
@erlend-aaslanderlend-aasland mentioned this pull request Jul 26, 2022
Merged
@erlend-aaslanderlend-aasland marked this pull request as ready for review July 27, 2022 14:06
@erlend-aasland
Copy link
ContributorAuthor

erlend-aasland commented Jul 27, 2022

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

@erlend-aaslanderlend-aasland changed the title gh-94635: Reorder sqlite3 docs a la Diátaxisgh-94635: Add Reference, How-to, and Concepts headings to sqlite3 docsJul 27, 2022
CAM-Gerlach
CAM-Gerlach reviewed Jul 28, 2022
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

Choose a reason for hiding this comment

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

A few minor textual suggestions, otherwise LGTM, thanks

CAM-Gerlach
CAM-Gerlach reviewed Jul 29, 2022
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

Choose a reason for hiding this comment

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

Just a couple minor followups, otherwise LGTM, thanks

@CAM-Gerlach
Update Doc/library/sqlite3.rst
2780291
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
@CAM-Gerlach
Update Doc/library/sqlite3.rst
d4cdbee
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
@erlend-aasland
Copy link
ContributorAuthor

erlend-aasland commented Jul 29, 2022

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
CAM-Gerlach approved these changes Jul 29, 2022
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM on my end, thanks @erlend-aasland

ezio-melotti
ezio-melotti approved these changes Jul 30, 2022
View reviewed changes
@erlend-aaslanderlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Jul 30, 2022
@erlend-aasland
Copy link
ContributorAuthor

erlend-aasland commented Jul 30, 2022

Thanks for the reviews, CAM and Ezio!

@erlend-aaslanderlend-aasland merged commit 6c439b9 into python:mainJul 30, 2022
@miss-islington
Copy link
Contributor

miss-islington commented Jul 30, 2022

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

@erlend-aaslanderlend-aasland deleted the sqlite-diataxis branch July 30, 2022 23:24
@miss-islington
Copy link
Contributor

miss-islington commented Jul 30, 2022

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
Copy link
Contributor

miss-islington commented Jul 30, 2022

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

erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Jul 30, 2022
@erlend-aasland
[3.11]pythongh-94635: Add Reference, How-to, and Concepts headings t…
2d05648
…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-botbedevere-bot removed the needs backport to 3.11 only security fixes label Jul 30, 2022
@bedevere-bot
Copy link

bedevere-bot commented Jul 30, 2022

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

@bedevere-bot
Copy link

bedevere-bot commented Jul 30, 2022

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

@bedevere-botbedevere-bot removed the needs backport to 3.10 only security fixes label Jul 30, 2022
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Jul 30, 2022
@erlend-aasland
[3.10]pythongh-94635: Add Reference, How-to, and Concepts headings t…
081571d
…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>
erlend-aasland added a commit that referenced this pull request Jul 31, 2022
@erlend-aasland
[3.11]gh-94635: Add Reference, How-to, and Explanation headings to s…
c7ac8b6
…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
erlend-aasland added a commit that referenced this pull request Jul 31, 2022
@erlend-aasland
[3.10]gh-94635: Add Reference, How-to, and Explanation headings to s…
6765a78
…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
@ezio-melottiezio-melotti mentioned this pull request Jul 31, 2022
Closed
CAM-Gerlach
CAM-Gerlach reviewed Jul 31, 2022
View reviewed changes
@CAM-GerlachCAM-Gerlach mentioned this pull request Aug 3, 2022
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@CAM-GerlachCAM-GerlachCAM-Gerlach approved these changes

@ezio-melottiezio-melottiezio-melotti approved these changes

@berkerpeksagberkerpeksagAwaiting requested review from berkerpeksagberkerpeksag is a code owner

@AA-TurnerAA-TurnerAwaiting requested review from AA-Turner

Assignees

@erlend-aaslanderlend-aasland

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Restructure the sqlite3 docs table-of-contents

5 participants

@erlend-aasland@miss-islington@bedevere-bot@CAM-Gerlach@ezio-melotti