FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

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

  1. python
  2. cpython

Repository navigation

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

Merged
erlend-aasland merged 11 commits into
python:mainfrom
erlend-aasland:sqlite-diataxis
Jul 30, 2022
ConversationCommits (11)ChecksFiles changed
Merged

gh-94635: Add Reference, How-to, and Concepts headings to sqlite3 docs#94636
erlend-aasland merged 11 commits into
python:mainfrom
erlend-aasland:sqlite-diataxis

Conversation

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

Copy link
Copy Markdown
Contributor

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

CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good overall; just a few comments.

Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
erlend-aasland marked this pull request as draft July 7, 2022 20:11

erlend-aasland commented Jul 7, 2022

Copy link
Copy Markdown
Contributor Author

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 reviewed Jul 7, 2022
View reviewed changes

ezio-melotti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

A step in the right direction!

Comment thread Doc/library/sqlite3.rst
Comment thread Doc/library/sqlite3.rst Outdated
erlend-aasland mentioned this pull request Jul 7, 2022
Closed
erlend-aasland mentioned this pull request Jul 26, 2022
Merged
erlend-aasland marked this pull request as ready for review July 27, 2022 14:06

erlend-aasland commented Jul 27, 2022

Copy link
Copy Markdown
Contributor Author

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-aasland changed the title gh-94635: Reorder sqlite3 docs a la Diátaxis gh-94635: Add Reference, How-to, and Concepts headings to sqlite3 docs Jul 27, 2022
CAM-Gerlach reviewed Jul 28, 2022
View reviewed changes

CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

A few minor textual suggestions, otherwise LGTM, thanks

Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
CAM-Gerlach reviewed Jul 29, 2022
View reviewed changes

CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Just a couple minor followups, otherwise LGTM, thanks

Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/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>

erlend-aasland commented Jul 29, 2022

Copy link
Copy Markdown
Contributor Author

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 approved these changes Jul 29, 2022
View reviewed changes

CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM on my end, thanks @erlend-aasland

ezio-melotti approved these changes Jul 30, 2022
View reviewed changes
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst

erlend-aasland commented Jul 30, 2022

Copy link
Copy Markdown
Contributor Author

Thanks for the reviews, CAM and Ezio!

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

miss-islington commented Jul 30, 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.
🐍🍒⛏🤖

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

miss-islington commented Jul 30, 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 6c439b978bf55b29f21c595e9375202d63c8208d 3.11

miss-islington commented Jul 30, 2022

Copy link
Copy Markdown
Contributor

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
[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-bot removed the needs backport to 3.11 only security fixes label Jul 30, 2022

bedevere-bot commented Jul 30, 2022

Copy link
Copy Markdown

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

bedevere-bot commented Jul 30, 2022

Copy link
Copy Markdown

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

erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Jul 30, 2022
[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
[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
[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-melotti mentioned this pull request Jul 31, 2022
Closed
CAM-Gerlach reviewed Jul 31, 2022
View reviewed changes
Comment thread Doc/library/sqlite3.rst
CAM-Gerlach mentioned this pull request Aug 3, 2022
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Assignees

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.

Restructure the sqlite3 docs table-of-contents

5 participants

Back | FazBrowse Home | New Git URL