Skip to content

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

Closed
#94629
Closed
Doc: Add explicit parameter list to sqlite3.connect#94628
#94629
Assignees
erlend-aasland
Labels
docsDocumentation in the Doc dirtopic-sqlite3type-featureA feature request or enhancement

Description

@erlend-aasland
erlend-aasland
opened on Jul 6, 2022

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.

Activity

  1. erlend-aasland
    self-assigned this
    on Jul 6, 2022
  2. erlend-aasland
    added
    docsDocumentation in the Doc dir
    topic-sqlite3
    type-featureA feature request or enhancement
    on Jul 6, 2022
  3. erlend-aasland
    added a commit that references this issue on Jul 6, 2022

    pythongh-94628: Add explicit parameter list to sqlite3.connect docs

    faa1085
  4. erlend-aasland
    linked a pull request that will close this issuegh-94628: Add explicit parameter list to sqlite3.connect docs #94629on Jul 6, 2022

  5. erlend-aasland commented on Jul 7, 2022

    @erlend-aasland
    erlend-aasland
    on Jul 7, 2022
    ContributorAuthor

    FTR, other candidates for explicit parameter lists:

    • sqlite3.Connection.create_*
    • sqlite3.Connection.blobopen
    • sqlite3.Connection.backup
  6. erlend-aasland
    closed this as completedin #94629on Jul 7, 2022
  7. Repository owner moved this from TODO: Docs to Done in sqlite3 issueson Jul 7, 2022
  8. erlend-aasland
    added 3 commits that reference this issue on Jul 7, 2022

    gh-94628: Add explicit parameter list to sqlite3.connect docs (#94629)

    3eb2b96

    [3.11] pythongh-94628: Add explicit parameter list to sqlite3.connect…

    b09efdd

    [3.10] pythongh-94628: Add explicit parameter list to sqlite3.connect…

    3934e9d

  9. erlend-aasland commented on Jul 7, 2022

    @erlend-aasland
    erlend-aasland
    on Jul 7, 2022
    ContributorAuthor

    Resolved in:

  10. erlend-aasland
    added 2 commits that reference this issue on Jul 7, 2022

    [3.11] gh-94628: Add explicit parameter list to sqlite3.connect docs (G…

    3517c13

    [3.10] gh-94628: Add explicit parameter list to sqlite3.connect docs (G…

    663aa6e

  11. erlend-aasland commented on Jul 7, 2022

    @erlend-aasland
    erlend-aasland
    on Jul 7, 2022
    ContributorAuthor

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

  12. sidney
    added a commit that references this issue on Jul 7, 2022

    pythongh-94628: Add explicit parameter list to sqlite3.connect docs (p…

    f9ff8d2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dirtopic-sqlite3type-featureA feature request or enhancement

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions