GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-90923: Improve sqlite3.Connection.execute* docs by erlend-aasland · Pull Request #91643 · python/cpython

Conversation

@erlend-aasland

@erlend-aasland 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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
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
@erlend-aasland
erlend-aasland requested a review from berkerpeksag as a code owner April 17, 2022 19:54
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Apr 17, 2022
@erlend-aasland erlend-aasland added the skip news label Apr 17, 2022
@erlend-aasland
erlend-aasland requested a review from AlexWaygood April 17, 2022 19:54
AlexWaygood
AlexWaygood reviewed Apr 17, 2022
View reviewed changes

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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").

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
erlend-aasland reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/sqlite3.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Erlend E. Aasland
Address review: use imperative mood
81ec1da
@erlend-aasland

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@erlend-aasland

erlend-aasland commented Apr 17, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@AlexWaygood

AlexWaygood commented Apr 17, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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 ;)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@JelleZijlstra JelleZijlstra added needs backport to 3.9 labels Apr 17, 2022
JelleZijlstra
JelleZijlstra approved these changes Apr 17, 2022
View reviewed changes

@JelleZijlstra JelleZijlstra left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
erlend-aasland reacted with hooray emoji
All reactions
  • 🎉 1 reaction
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting review labels Apr 17, 2022
@JelleZijlstra JelleZijlstra self-assigned this Apr 17, 2022
@erlend-aasland

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! :)
AlexWaygood reacted with hooray emoji AlexWaygood reacted with rocket emoji
All reactions
  • 🎉 1 reaction
  • 🚀 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@JelleZijlstra
JelleZijlstra merged commit 017f07a into python:main Apr 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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the awaiting merge label Apr 17, 2022
@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 <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the needs backport to 3.9 label Apr 17, 2022
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
miss-islington added a commit that referenced this pull request Apr 17, 2022
@miss-islington Erlend 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 <[email protected]>
miss-islington added a commit that referenced this pull request Apr 17, 2022
@miss-islington Erlend 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 <[email protected]>
hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022
@miss-islington Erlend 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 <[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

Uh oh!

There was an error while loading. Please reload this page.

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

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@erlend-aasland @AlexWaygood @miss-islington @bedevere-bot @JelleZijlstra
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.