FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-90923: Improve sqlite3.Connection.execute* docs by erlend-aasland · Pull Request #91643 · python/cpython · GitHub

/ cpython Public

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
ConversationCommits (2)ChecksFiles changed
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 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

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

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated

erlend-aasland commented Apr 17, 2022

Copy link
Copy Markdown
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 commented Apr 17, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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

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 approved these changes Apr 17, 2022
View reviewed changes

JelleZijlstra 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

JelleZijlstra self-assigned this Apr 17, 2022

erlend-aasland commented Apr 17, 2022

Copy link
Copy Markdown
Contributor Author

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

Imperative! :)

JelleZijlstra merged commit 017f07a into python:main Apr 17, 2022

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 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
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-bot removed the needs backport to 3.10 only security fixes label Apr 17, 2022

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 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
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
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
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

AlexWaygood AlexWaygood left review comments
JelleZijlstra JelleZijlstra approved these changes
berkerpeksag Awaiting requested review from berkerpeksag

Assignees

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

Back | FazBrowse Home | New Git URL