Skip to content
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

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

Merged
merged 14 commits into from
Nov 15, 2021
Merged

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

merged 14 commits into from
Nov 15, 2021

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Oct 29, 2021 •
edited
Loading

@erlend-aasland erlend-aasland added needs backport to 3.9 only security fixes 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
Copy link
Contributor Author

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

jacobtylerwalls
jacobtylerwalls reviewed Oct 31, 2021
View reviewed changes
Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
Erlend Egeberg Aasland and others added 2 commits October 31, 2021 09:40
@jacobtylerwalls
Update Doc/library/sqlite3.rst
15008ee 
Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
Address review: adjust wording
4d53130
AlexWaygood
AlexWaygood requested changes Oct 31, 2021
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

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 :)

Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
Doc/library/sqlite3.rst Outdated Show resolved Hide resolved
Lib/sqlite3/__init__.py Outdated Show resolved Hide resolved
Lib/sqlite3/__init__.py Outdated Show resolved Hide resolved
Erlend Egeberg Aasland and others added 8 commits October 31, 2021 14:36
@AlexWaygood
Update Doc/library/sqlite3.rst
f5ce4af 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@AlexWaygood
Update Lib/sqlite3/__init__.py
e9c3e97 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@AlexWaygood
Update Doc/library/sqlite3.rst
86efc85 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@AlexWaygood
Update Doc/library/sqlite3.rst
6923fee 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@AlexWaygood
Update Lib/sqlite3/__init__.py
c794d16 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@AlexWaygood
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
Copy link
Contributor Author

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

@erlend-aasland erlend-aasland changed the title bpo-45677: Avoid addressing the reader as 'you' in sqlite3 docs bpo-45677: Reword first section of sqlite3 docs Nov 3, 2021
@willingc willingc merged commit 6c5a312 into python:main Nov 15, 2021
@miss-islington
Copy link
Contributor

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

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 15, 2021
@miss-islington
bpo-45677: Reword first section of sqlite3 docs (pythonGH-29326)
d9bc0dd 
* 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
Copy link

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

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

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 15, 2021
@miss-islington
bpo-45677: Reword first section of sqlite3 docs (pythonGH-29326)
fb0613a 
* 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 erlend-aasland deleted the sqlite-doc-you/part1 branch November 15, 2021 22:31
@erlend-aasland
Copy link
Contributor Author

Thanks, Carol!

willingc pushed a commit that referenced this pull request Nov 15, 2021
@miss-islington
bpo-45677: Reword first section of sqlite3 docs (GH-29326) (GH-29566)
94dad5e 
* 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>
willingc pushed a commit that referenced this pull request Nov 15, 2021
@miss-islington
bpo-45677: Reword first section of sqlite3 docs (GH-29326) (GH-29567)
a40d066 
* 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>
remykarem pushed a commit to remykarem/cpython that referenced this pull request Dec 7, 2021
@jacobtylerwalls @AlexWaygood @remykarem
bpo-45677: Reword first section of sqlite3 docs (python#29326)
258ec73 
* 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>
@erlend-aasland erlend-aasland mentioned this pull request May 16, 2022
Closed
@erlend-aasland erlend-aasland mentioned this pull request Jul 27, 2022
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood requested changes

@jacobtylerwalls jacobtylerwalls jacobtylerwalls left review comments

@berkerpeksag berkerpeksag Awaiting requested review from berkerpeksag berkerpeksag is a code owner

@willingc willingc Awaiting requested review from willingc

@Mariatta Mariatta Awaiting requested review from Mariatta

Assignees
No one assigned
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.
7 participants
@erlend-aasland @miss-islington @bedevere-bot @jacobtylerwalls @AlexWaygood @willingc @the-knights-who-say-ni