GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-94635: Add Reference, How-to, and Concepts headings to sqlite3 docs by erlend-aasland · Pull Request #94636 · python/cpython

Conversation

@erlend-aasland

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor
  • Issue: Restructure the sqlite3 docs table-of-contents #94635

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@erlend-aasland
erlend-aasland requested a review from berkerpeksag as a code owner July 6, 2022 23:40
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 6, 2022
@erlend-aasland 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
erlend-aasland force-pushed the sqlite-diataxis branch from 841d158 to 9c94eed Compare July 6, 2022 23:41
@erlend-aasland erlend-aasland added the skip news label Jul 6, 2022
@erlend-aasland
erlend-aasland requested review from AA-Turner and CAM-Gerlach July 6, 2022 23:44
@erlend-aasland
pythongh-94635: Reorder sqlite3 docs a la Diátaxis
05e4c21
@erlend-aasland
erlend-aasland force-pushed the sqlite-diataxis branch from 9c94eed to 05e4c21 Compare July 6, 2022 23:46
CAM-Gerlach
CAM-Gerlach reviewed Jul 7, 2022
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@erlend-aasland
erlend-aasland marked this pull request as draft July 7, 2022 20:11
@erlend-aasland erlend-aasland added the DO-NOT-MERGE label Jul 7, 2022
@erlend-aasland

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 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

ezio-melotti
ezio-melotti reviewed Jul 7, 2022
View reviewed changes

@ezio-melotti ezio-melotti left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland reacted with heart emoji
All reactions
  • ❤️ 1 reaction
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@erlend-aasland erlend-aasland mentioned this pull request Jul 7, 2022
Restructure the sqlite3 docs table-of-contents #94635
Closed
@erlend-aasland 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
@erlend-aasland
Address reviews
3ed9049
@erlend-aasland
Syntax fix
175f823
@erlend-aasland
How-to guides a la diataxis
dbc4079
@erlend-aasland erlend-aasland removed the DO-NOT-MERGE label Jul 27, 2022
@erlend-aasland
erlend-aasland marked this pull request as ready for review July 27, 2022 14:06
@erlend-aasland
erlend-aasland requested review from CAM-Gerlach and ezio-melotti July 27, 2022 14:06
@erlend-aasland

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@erlend-aasland
Partially adress CAM's review
c529b7f
CAM-Gerlach
CAM-Gerlach reviewed Jul 29, 2022
View reviewed changes

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland reacted with hooray emoji
All reactions
  • 🎉 1 reaction
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Erlend Egeberg Aasland @CAM-Gerlach
Update Doc/library/sqlite3.rst
2780291
Co-authored-by: CAM Gerlach <[email protected]>
Erlend Egeberg Aasland @CAM-Gerlach
Update Doc/library/sqlite3.rst
d4cdbee
Co-authored-by: CAM Gerlach <[email protected]>
@erlend-aasland

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 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

erlend-aasland reacted with hooray emoji
All reactions
  • 🎉 1 reaction
ezio-melotti
ezio-melotti approved these changes Jul 30, 2022
View reviewed changes
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Jul 30, 2022
Erlend Egeberg Aasland and others added 3 commits July 30, 2022 23:32
Erlend Egeberg Aasland
Don't link to the module inside the module docs
d53d11d
@erlend-aasland
Merge remote-tracking branch 'upstream/main' into sqlite-diataxis
12854e1
@erlend-aasland
Fix merge
56e0139
@erlend-aasland erlend-aasland added needs backport to 3.10 needs backport to 3.11 only security fixes labels Jul 30, 2022
@erlend-aasland

erlend-aasland commented Jul 30, 2022

Copy link
Copy Markdown
Contributor Author

Thanks for the reviews, CAM and Ezio!

ezio-melotti reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

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.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot bedevere-bot removed the awaiting merge label Jul 30, 2022
@erlend-aasland
erlend-aasland deleted the sqlite-diataxis branch July 30, 2022 23:24
@miss-islington

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@miss-islington miss-islington assigned erlend-aasland Jul 30, 2022
@miss-islington

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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 <[email protected]>.
(cherry picked from commit 6c439b9)

Co-authored-by: Erlend Egeberg Aasland <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 30, 2022
@bedevere-bot

bedevere-bot commented Jul 30, 2022

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot

bedevere-bot commented Jul 30, 2022

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 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 <[email protected]>.
(cherry picked from commit 6c439b9)

Co-authored-by: Erlend Egeberg Aasland <[email protected]>
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 <[email protected]>.
(cherry picked from commit 6c439b9)

Co-authored-by: Erlend Egeberg Aasland <[email protected]>

* 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 <[email protected]>.
(cherry picked from commit 6c439b9)

Co-authored-by: Erlend Egeberg Aasland <[email protected]>

* Fix refs
@ezio-melotti ezio-melotti mentioned this pull request Jul 31, 2022
Style guide suggestion: Avoid duplicate links python/docs-community#52
Closed
CAM-Gerlach
CAM-Gerlach reviewed Jul 31, 2022
View reviewed changes
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@CAM-Gerlach CAM-Gerlach mentioned this pull request Aug 3, 2022
Clarify best practices with ref target labels in docs python/devguide#927
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@erlend-aasland 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

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@erlend-aasland @miss-islington @bedevere-bot @CAM-Gerlach @ezio-melotti
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.