Skip to content

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

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

Copy link
Copy Markdown
Contributor

@erlend-aaslanderlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Aug 1, 2022
@erlend-aaslanderlend-aasland mentioned this pull request Aug 1, 2022
Closed
5 tasks
@erlend-aaslanderlend-aasland linked an issue Aug 1, 2022 that may be closed by this pull request
Improve the sqlite3 reference #95273
Closed
5 tasks
@erlend-aaslanderlend-aasland changed the title gh-95273: Improve return values and exceptions raised for sqlite3 class methodsgh-95273: Improve documented return values and exceptions raised for sqlite3 class methodsAug 1, 2022
ezio-melotti
ezio-melotti reviewed Aug 4, 2022
View reviewed changes
Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/sqlite3.rst Outdated
Comment threadDoc/library/sqlite3.rst Outdated
@ezio-melotti

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

erlend-aasland commented Aug 4, 2022

Copy link
Copy Markdown
ContributorAuthor

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
AlexWaygood approved these changes Aug 4, 2022
View reviewed changes

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

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 threadDoc/library/sqlite3.rst Outdated
Erlend Egeberg Aaslandand others added 3 commits August 4, 2022 13:50
@erlend-aasland

erlend-aasland commented Aug 4, 2022

Copy link
Copy Markdown
ContributorAuthor

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

ezio-melotti
ezio-melotti reviewed Aug 4, 2022
View reviewed changes
Comment threadDoc/library/sqlite3.rst
@erlend-aasland
erlend-aasland merged commit 12d92c7 into python:mainAug 4, 2022
@miss-islington

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

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
erlend-aasland deleted the sqlite-reference/return-and-except branch August 4, 2022 19:58
@miss-islington

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-aaslanderlend-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

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

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

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

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

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-botbedevere-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
@erlend-aasland
[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
@erlend-aasland
[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-botbedevere-bot removed the needs backport to 3.10 only security fixes label Aug 4, 2022
@bedevere-bot

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
@erlend-aasland
[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
@erlend-aasland
[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
@erlend-aasland@ezio-melotti
@AlexWaygood@iritkatriel
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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ezio-melottiezio-melottiezio-melotti left review comments
@AlexWaygoodAlexWaygoodAlexWaygood approved these changes
@berkerpeksagberkerpeksagAwaiting requested review from berkerpeksag

Assignees

@erlend-aaslanderlend-aasland

Labels

docsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve the sqlite3 reference

5 participants

@erlend-aasland@ezio-melotti@miss-islington@bedevere-bot@AlexWaygood