bpo-45677: Reword first section of `sqlite3` docs by erlend-aasland · Pull Request #29326 · python/cpython

erlend-aasland · 2021-10-29T22:00:31Z

https://bugs.python.org/issue45677

erlend-aasland · 2021-10-29T22:01:53Z

It would be nice to have a native english speaker verify these changes.

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>

AlexWaygood

This looks like a solid improvement, but here are a few thoughts. (I'm not a sqlite expert by any means, but I am a native English speaker, and have a masters in journalism :)

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

erlend-aasland · 2021-11-01T10:20:57Z

FYI, @AlexWaygood and @jacobtylerwalls. See also the topic Using personal or passive tone in the docs on Discourse.

miss-islington · 2021-11-15T22:22:47Z

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

bedevere-bot · 2021-11-15T22:22:47Z

@willingc: Please replace # with GH- in the commit message next time. Thanks!

* bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs * Adjust wording * Adjust wording again * Typo * Update Doc/library/sqlite3.rst Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> * Address review: adjust wording * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Apply Alex' suggestion, and apply 80 char limit to PR * Minor adjustment Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 6c5a312) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

bedevere-bot · 2021-11-15T22:23:06Z

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

bedevere-bot · 2021-11-15T22:23:12Z

GH-29567 is a backport of this pull request to the 3.9 branch.

* bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs * Adjust wording * Adjust wording again * Typo * Update Doc/library/sqlite3.rst Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> * Address review: adjust wording * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Apply Alex' suggestion, and apply 80 char limit to PR * Minor adjustment Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 6c5a312) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

erlend-aasland · 2021-11-15T22:31:55Z

Thanks, Carol!

* bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs * Adjust wording * Adjust wording again * Typo * Update Doc/library/sqlite3.rst Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> * Address review: adjust wording * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Apply Alex' suggestion, and apply 80 char limit to PR * Minor adjustment Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 6c5a312) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no> Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>

* bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs * Adjust wording * Adjust wording again * Typo * Update Doc/library/sqlite3.rst Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> * Address review: adjust wording * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Lib/sqlite3/__init__.py Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Update Doc/library/sqlite3.rst Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * Apply Alex' suggestion, and apply 80 char limit to PR * Minor adjustment Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs
af15b22

erlend-aasland requested a review from berkerpeksag as a code owner October 29, 2021 22:00

the-knights-who-say-ni added the CLA signed label Oct 29, 2021

bedevere-bot added the awaiting review label Oct 29, 2021

erlend-aasland added needs backport to 3.9 needs backport to 3.10 only security fixes skip news docs Documentation in the Doc dir and removed awaiting review labels Oct 29, 2021

erlend-aasland requested a review from willingc October 29, 2021 22:02

Erlend E. Aasland added 3 commits October 30, 2021 00:04

Adjust wording
c1e758d

Adjust wording again
204052c

Typo
02d2a53

jacobtylerwalls reviewed Oct 31, 2021
View reviewed changes

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

Erlend Egeberg Aaslandand others added 2 commits October 31, 2021 09:40

Update Doc/library/sqlite3.rst
15008ee
Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>

Address review: adjust wording
4d53130

AlexWaygood requested changes Oct 31, 2021
View reviewed changes

bedevere-bot added the awaiting core review label Oct 31, 2021

Erlend Egeberg Aaslandand others added 8 commits October 31, 2021 14:36

Update Doc/library/sqlite3.rst
f5ce4af
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Update Lib/sqlite3/__init__.py
e9c3e97
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Update Doc/library/sqlite3.rst
86efc85
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Update Doc/library/sqlite3.rst
6923fee
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Update Lib/sqlite3/__init__.py
c794d16
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Update Doc/library/sqlite3.rst
f405915
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Apply Alex' suggestion, and apply 80 char limit to PR
d451f9d

Minor adjustment
9bd8121

erlend-aasland requested a review from Mariatta October 31, 2021 19:54

erlend-aasland changed the title ~~bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs~~bpo-45677: Reword first section of sqlite3 docsNov 3, 2021

willingc merged commit 6c5a312 into python:mainNov 15, 2021

bedevere-bot removed the awaiting core review label Nov 15, 2021

bedevere-bot removed needs backport to 3.10 only security fixes needs backport to 3.9 labels Nov 15, 2021

erlend-aasland deleted the sqlite-doc-you/part1 branch November 15, 2021 22:31

erlend-aasland mentioned this pull request May 16, 2022
[doc] improve sqlite3 docs #89840
Closed

erlend-aasland mentioned this pull request Jul 27, 2022
Improve the sqlite3 reference #95273
Closed
5 tasks

Navigation Menu

Uh oh!

Uh oh!

bpo-45677: Reword first section of `sqlite3` docs - #29326

bpo-45677: Reword first section of `sqlite3` docs#29326
willingc merged 14 commits into
python:mainfrom
erlend-aasland:sqlite-doc-you/part1

erlend-aasland commented Oct 29, 2021•
edited
Loading

Uh oh!

erlend-aasland commented Oct 29, 2021

Uh oh!

Uh oh!

Uh oh!

AlexWaygood left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Nov 1, 2021

Uh oh!

miss-islington commented Nov 15, 2021

Uh oh!

bedevere-bot commented Nov 15, 2021

Uh oh!

bedevere-bot commented Nov 15, 2021

Uh oh!

bedevere-bot commented Nov 15, 2021

Uh oh!

erlend-aasland commented Nov 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Uh oh!

Uh oh!

Conversation

erlend-aasland commented Oct 29, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erlend-aasland commented Oct 29, 2021

Uh oh!

Uh oh!

Uh oh!

AlexWaygood 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!

erlend-aasland commented Nov 1, 2021

Uh oh!

miss-islington commented Nov 15, 2021

Uh oh!

bedevere-bot commented Nov 15, 2021

Uh oh!

bedevere-bot commented Nov 15, 2021

Uh oh!

bedevere-bot commented Nov 15, 2021

Uh oh!

erlend-aasland commented Nov 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

erlend-aasland commented Oct 29, 2021•
edited
Loading