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

gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods by erlend-aasland · Pull Request #95530 · python/cpython · GitHub

/ cpython Public

gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods - #95530

Merged
erlend-aasland merged 8 commits into
python:mainfrom
erlend-aasland:sqlite-reference/return-and-except
Aug 4, 2022
ConversationCommits (8)ChecksFiles changed
Merged

gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods#95530
erlend-aasland merged 8 commits into
python:mainfrom
erlend-aasland:sqlite-reference/return-and-except

Conversation

erlend-aasland commented Aug 1, 2022 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

erlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Aug 1, 2022
bedevere-bot added awaiting core review docs Documentation in the Doc dir skip news labels Aug 1, 2022
erlend-aasland mentioned this pull request Aug 1, 2022
Closed
5 tasks
erlend-aasland linked an issue Aug 1, 2022 that may be closed by this pull request
Improve the sqlite3 reference #95273
Closed
5 tasks
erlend-aasland changed the title gh-95273: Improve return values and exceptions raised for sqlite3 class methods gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods Aug 1, 2022
ezio-melotti reviewed Aug 4, 2022
View reviewed changes
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated
Comment thread Doc/library/sqlite3.rst Outdated

ezio-melotti commented Aug 4, 2022

Copy link
Copy Markdown
Member

(@erlend-aasland: I fixed a merge conflict, if you are going to make changes to your local branch remember to pull the merge before you create more commits.)

erlend-aasland commented Aug 4, 2022

Copy link
Copy Markdown
Contributor Author

Thanks for the review Ezio! I'm extending this PR to use parameter lists in a few more cases. I'll ping you again when I'm ready for a second review.

AlexWaygood approved these changes Aug 4, 2022
View reviewed changes

AlexWaygood left a comment •
edited
Loading

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

The words look good, and I'm always in favour of more type hints in the docs (where they're useful)! I'll leave the ReST/Sphinx syntax to Ezio :D

Comment thread Doc/library/sqlite3.rst Outdated
Erlend Egeberg Aasland and others added 3 commits August 4, 2022 13:50

erlend-aasland commented Aug 4, 2022

Copy link
Copy Markdown
Contributor Author

FTR, I'm going to land this later today.

ezio-melotti reviewed Aug 4, 2022
View reviewed changes
Comment thread Doc/library/sqlite3.rst
erlend-aasland merged commit 12d92c7 into python:main Aug 4, 2022

miss-islington commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

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

miss-islington commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

Sorry @erlend-aasland, I had trouble checking out the 3.11 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 12d92c733cfc00ee630b30e4e0250da400c83395 3.11

erlend-aasland deleted the sqlite-reference/return-and-except branch August 4, 2022 19:58

miss-islington commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

Sorry, @erlend-aasland, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 12d92c733cfc00ee630b30e4e0250da400c83395 3.10

erlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes and removed needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Aug 4, 2022

miss-islington commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

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

miss-islington commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

Sorry @erlend-aasland, I had trouble checking out the 3.11 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 12d92c733cfc00ee630b30e4e0250da400c83395 3.11

miss-islington commented Aug 4, 2022

Copy link
Copy Markdown
Contributor

Sorry @erlend-aasland, I had trouble checking out the 3.10 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 12d92c733cfc00ee630b30e4e0250da400c83395 3.10

bedevere-bot commented Aug 4, 2022

Copy link
Copy Markdown

GH-95673 is a backport of this pull request to the 3.11 branch.

bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 4, 2022
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 4, 2022
[3.11] pythongh-95273: Improve documented return values and exception…
f86a981 
…s raised for sqlite3 class methods (pythonGH-95530)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 12d92c7)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 4, 2022
[3.10] pythongh-95273: Improve documented return values and exception…
1e6ceaf 
…s raised for sqlite3 class methods (pythonGH-95530)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 12d92c7)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
bedevere-bot removed the needs backport to 3.10 only security fixes label Aug 4, 2022

bedevere-bot commented Aug 4, 2022

Copy link
Copy Markdown

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

erlend-aasland added a commit that referenced this pull request Aug 4, 2022
[3.11] gh-95273: Improve documented return values and exceptions rais…
c9986be 
…ed for sqlite3 class methods (GH-95530) (#95673)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 12d92c7)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
erlend-aasland added a commit that referenced this pull request Aug 4, 2022
[3.10] gh-95273: Improve documented return values and exceptions rais…
4a204c1 
…ed for sqlite3 class methods (GH-95530) (#95674)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 12d92c7)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
iritkatriel pushed a commit to iritkatriel/cpython that referenced this pull request Aug 11, 2022
pythongh-95273: Improve documented return values and exceptions raise…
26026fe 
…d for sqlite3 class methods (python#95530)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
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

ezio-melotti ezio-melotti left review comments
AlexWaygood AlexWaygood approved these changes
berkerpeksag Awaiting requested review from berkerpeksag

Assignees

erlend-aasland

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.

Improve the sqlite3 reference

5 participants

Back | FazBrowse Home | New Git URL