Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

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
Merged
merged 2 commits into from
Apr 17, 2022
Merged

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

merged 2 commits into from
Apr 17, 2022

Conversation

erlend-aasland
Copy link
Contributor

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

Resolves #90923

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-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Apr 17, 2022
AlexWaygood
AlexWaygood reviewed Apr 17, 2022
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.

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").

@erlend-aasland
Copy link
Contributor Author

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

erlend-aasland commented Apr 17, 2022 •
edited
Loading

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

@AlexWaygood
Copy link
Member

AlexWaygood commented Apr 17, 2022 •
edited
Loading

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 added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Apr 17, 2022
JelleZijlstra
JelleZijlstra approved these changes Apr 17, 2022
View reviewed changes
Copy link
Member

@JelleZijlstra JelleZijlstra left a comment

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.

@JelleZijlstra JelleZijlstra self-assigned this Apr 17, 2022
@erlend-aasland
Copy link
Contributor Author

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:main Apr 17, 2022
@miss-islington
Copy link
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
@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 <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Apr 17, 2022
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Apr 17, 2022
@bedevere-bot
Copy link

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-islington
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 <[email protected]>
miss-islington added a commit that referenced this pull request Apr 17, 2022
@miss-islington
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 <[email protected]>
hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022
@miss-islington @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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood left review comments

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

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

Assignees

@JelleZijlstra JelleZijlstra

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.

[Doc] sqlite3 Cursor.execute() return value is unspecified
5 participants
@erlend-aasland @AlexWaygood @miss-islington @bedevere-bot @JelleZijlstra