Skip to content

Doc: Add explicit parameter list to sqlite3.connect #94628

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
Closed
erlend-aasland opened this issue Jul 6, 2022 · 3 comments · Fixed by #94629
Closed

Doc: Add explicit parameter list to sqlite3.connect #94628

erlend-aasland opened this issue Jul 6, 2022 · 3 comments · Fixed by #94629
Assignees
@erlend-aasland
Labels
docs Documentation in the Doc dir topic-sqlite3 type-feature A feature request or enhancement

Comments

@erlend-aasland
Copy link
Contributor

The sqlite3.connect module level function has a lot of parameters. Adding an explicit parameter list will add more structure to this function.

Discussed on Discourse, with a proof-of-concept given by CAM.

For now, I do not suggest to adapt all sqlite3 functions and methods to this doc style. That is, however, a possibility, but since most of the functions / methods accept only a very small number of parameters, I'm unsure of the gain.
@erlend-aasland erlend-aasland self-assigned this Jul 6, 2022
@erlend-aasland erlend-aasland added docs Documentation in the Doc dir topic-sqlite3 type-feature A feature request or enhancement labels Jul 6, 2022
@bedevere-bot bedevere-bot mentioned this issue Jul 6, 2022
Merged
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Jul 6, 2022
@erlend-aasland
pythongh-94628: Add explicit parameter list to sqlite3.connect docs
faa1085
@erlend-aasland erlend-aasland linked a pull request Jul 6, 2022 that will close this issue
gh-94628: Add explicit parameter list to sqlite3.connect docs #94629
Merged
@erlend-aasland
Copy link
Contributor Author

FTR, other candidates for explicit parameter lists:

  • sqlite3.Connection.create_*
  • sqlite3.Connection.blobopen
  • sqlite3.Connection.backup

Repository owner moved this from TODO: Docs to Done in sqlite3 issues Jul 7, 2022
erlend-aasland added a commit that referenced this issue Jul 7, 2022
@erlend-aasland @CAM-Gerlach
gh-94628: Add explicit parameter list to sqlite3.connect docs (#94629)
3eb2b96 
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot bedevere-bot mentioned this issue Jul 7, 2022
Merged
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Jul 7, 2022
@erlend-aasland
[3.11] pythongh-94628: Add explicit parameter list to sqlite3.connect…
b09efdd 
… docs (pythonGH-94629)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 3eb2b96)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Jul 7, 2022
@erlend-aasland
[3.10] pythongh-94628: Add explicit parameter list to sqlite3.connect…
3934e9d 
… docs (pythonGH-94629)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 3eb2b96)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
@bedevere-bot bedevere-bot mentioned this issue Jul 7, 2022
Merged
@erlend-aasland
Copy link
Contributor Author

Resolved in:

erlend-aasland added a commit that referenced this issue Jul 7, 2022
@erlend-aasland
[3.11] gh-94628: Add explicit parameter list to sqlite3.connect docs (G…
3517c13 
…H-94629) (#94645)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 3eb2b96)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
erlend-aasland added a commit that referenced this issue Jul 7, 2022
@erlend-aasland
[3.10] gh-94628: Add explicit parameter list to sqlite3.connect docs (G…
663aa6e 
…H-94629) (#94646)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 3eb2b96)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
@erlend-aasland
Copy link
Contributor Author

Closed; thanks for the good work with this, @CAM-Gerlach!

sidney pushed a commit to sidney/cpython that referenced this issue Jul 7, 2022
@erlend-aasland @CAM-Gerlach @sidney
pythongh-94628: Add explicit parameter list to sqlite3.connect docs (p…
f9ff8d2 
…ython#94629)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
@erlend-aasland erlend-aasland mentioned this issue Jul 27, 2022
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@erlend-aasland erlend-aasland

Labels
docs Documentation in the Doc dir topic-sqlite3 type-feature A feature request or enhancement
Projects
sqlite3 issues
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-94628: Add explicit parameter list to sqlite3.connect docs erlend-aasland/cpython
1 participant
@erlend-aasland