Skip to content

gh-90923: Improve sqlite3.Connection.execute* docs - #91643

Merged
JelleZijlstra merged 2 commits into
python:mainfrom
erlend-aasland:sqlite-doc-cursor-return
Apr 17, 2022
Merged

gh-90923: Improve sqlite3.Connection.execute* docs#91643
JelleZijlstra merged 2 commits into
python:mainfrom
erlend-aasland:sqlite-doc-cursor-return

Conversation

@erlend-aasland

@erlend-aaslanderlend-aasland commented Apr 17, 2022

Copy link
Copy Markdown
Contributor
  • Drop 'nonstandard'; it does not add any value
  • Try to be more concise
  • Make return value a little more explicit

Resolves#90923

Erlend E. Aasland
pythongh-90923: Improve sqlite3.Connection.execute* docs
0a48dd6
- Drop 'nonstandard'; it does not add any value
- Try to be more concise
- Make return value a little more explicit
@bedevere-botbedevere-bot added docs Documentation in the Doc dir awaiting review labels Apr 17, 2022
AlexWaygood
AlexWaygood reviewed Apr 17, 2022
View reviewed changes

@AlexWaygoodAlexWaygood 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.

Looks like a nice improvement! Just one nit: for terse API references, I generally think the imperative mood sounds better than the indicative ("return the cursor object" rather than "returns the cursor object").

Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/sqlite3.rst Outdated
@erlend-aasland

erlend-aasland commented Apr 17, 2022

Copy link
Copy Markdown
ContributorAuthor

Looks like a nice improvement! Just one nit: for terse API references, I generally think the imperative mood sounds better than the indicative [...]

Great, thank you very much :)

@erlend-aasland

erlend-aasland commented Apr 17, 2022•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

@JelleZijlstra, would you mind landing this? (I'd also appreciate your review)

@AlexWaygood

AlexWaygood commented Apr 17, 2022•
edited
Loading

Copy link
Copy Markdown
Member

Looks like a nice improvement! Just one nit: for terse API references, I generally think the imperative mood sounds better than the indicative [...]

Great, thank you very much :)

No problem! I have just realised that the rest of this document uses indicative (boo!), so my suggested revisions might actually put these entries out of place with the rest of the doc 🤦‍♂️ I still think it sounds better with my revisions, though, so I'll leave it to you to decide ;)

JelleZijlstra
JelleZijlstra approved these changes Apr 17, 2022
View reviewed changes

@JelleZijlstraJelleZijlstra 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.

Looks good to me, I have no strong view on what mood to use.

@JelleZijlstraJelleZijlstra self-assigned this Apr 17, 2022
@erlend-aasland

erlend-aasland commented Apr 17, 2022

Copy link
Copy Markdown
ContributorAuthor

I still think it sounds better with my revisions, though, so I'll leave it to you to decide ;)

Imperative! :)

@JelleZijlstra
JelleZijlstra merged commit 017f07a into python:mainApr 17, 2022
@miss-islington

miss-islington commented Apr 17, 2022

Copy link
Copy Markdown
Contributor

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

@erlend-aasland
erlend-aasland deleted the sqlite-doc-cursor-return branch April 17, 2022 21:13
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 17, 2022
Erlend Egeberg Aasland@miss-islington
pythongh-90923: Improve sqlite3.Connection.execute* docs (pythonGH-91643
4dfd05f
)
- Drop 'nonstandard'; it does not add any value
- Try to be more concise
- Make return value a little more explicit
(cherry picked from commit 017f07a)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
@bedevere-botbedevere-bot removed the needs backport to 3.10 only security fixes label Apr 17, 2022
@bedevere-bot

bedevere-bot commented Apr 17, 2022

Copy link
Copy Markdown

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

@bedevere-bot

bedevere-bot commented Apr 17, 2022

Copy link
Copy Markdown

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

miss-islington added a commit that referenced this pull request Apr 17, 2022
@miss-islingtonErlend Egeberg Aasland
gh-90923: Improve sqlite3.Connection.execute* docs (GH-91643)
2bcfe20
- Drop 'nonstandard'; it does not add any value
- Try to be more concise
- Make return value a little more explicit
(cherry picked from commit 017f07a)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
miss-islington added a commit that referenced this pull request Apr 17, 2022
@miss-islingtonErlend Egeberg Aasland
gh-90923: Improve sqlite3.Connection.execute* docs (GH-91643)
833ff16
- Drop 'nonstandard'; it does not add any value
- Try to be more concise
- Make return value a little more explicit
(cherry picked from commit 017f07a)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022
@miss-islingtonErlend Egeberg Aasland@hello-adam
pythongh-90923: Improve sqlite3.Connection.execute* docs (pythonGH-91643
21a92d3
)
- Drop 'nonstandard'; it does not add any value
- Try to be more concise
- Make return value a little more explicit
(cherry picked from commit 017f07a)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygoodAlexWaygoodAlexWaygood left review comments
@JelleZijlstraJelleZijlstraJelleZijlstra approved these changes
@berkerpeksagberkerpeksagAwaiting requested review from berkerpeksag

Assignees

@JelleZijlstraJelleZijlstra

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Doc] sqlite3 Cursor.execute() return value is unspecified

5 participants

@erlend-aasland@AlexWaygood@miss-islington@bedevere-bot@JelleZijlstra