Skip to content

[doc] add sqlite3 module docstring #89775

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.

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

Closed
erlend-aasland opened this issue Oct 26, 2021 · 5 comments
Closed

[doc] add sqlite3 module docstring #89775

erlend-aasland opened this issue Oct 26, 2021 · 5 comments
Labels
3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir topic-sqlite3

Comments

@erlend-aasland
Copy link
Contributor

BPO 45612
Nosy @ambv, @miss-islington, @erlend-aasland
PRs
  • bpo-45612: Add sqlite3 module docstring #29224
  • [3.10] bpo-45612: Add sqlite3 module docstring (GH-29224) #29288
  • [3.9] bpo-45612: Add sqlite3 module docstring (GH-29224) #29289
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
    closed_at = <Date 2021-10-28.20:25:57.490>
    created_at = <Date 2021-10-26.08:12:44.671>
    labels = ['3.11', '3.9', '3.10', 'docs']
    title = '[doc] add sqlite3 module docstring'
    updated_at = <Date 2021-10-28.20:25:57.490>
    user = 'https://github.com/erlend-aasland'

    bugs.python.org fields:

    activity = <Date 2021-10-28.20:25:57.490>
    actor = 'lukasz.langa'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2021-10-28.20:25:57.490>
    closer = 'lukasz.langa'
    components = ['Documentation']
    creation = <Date 2021-10-26.08:12:44.671>
    creator = 'erlendaasland'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 45612
    keywords = ['patch']
    message_count = 5.0
    messages = ['405030', '405245', '405262', '405263', '405264']
    nosy_count = 4.0
    nosy_names = ['docs@python', 'lukasz.langa', 'miss-islington', 'erlendaasland']
    pr_nums = ['29224', '29288', '29289']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue45612'
    versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

    @erlend-aasland
    Copy link
    Contributor Author

    Currently, the sqlite3 module docstring is the old pysqlite copyright comment in the start of Lib/sqlite3/init.py. This is not very helpful to the general user. Suggesting to add a more helpful docstring, a la the 're' or 'array' modules (those two were randomly picked among stdlib modules with helpful docstrings).

    @erlend-aasland erlend-aasland added 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes labels Oct 26, 2021
    @erlend-aasland erlend-aasland added docs Documentation in the Doc dir 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes labels Oct 26, 2021
    @erlend-aasland erlend-aasland added the docs Documentation in the Doc dir label Oct 26, 2021
    @ambv
    Copy link
    Contributor

    ambv commented Oct 28, 2021

    New changeset 4dd1e84 by Erlend Egeberg Aasland in branch 'main':
    bpo-45612: Add sqlite3 module docstring (GH-29224)
    4dd1e84

    @ambv
    Copy link
    Contributor

    ambv commented Oct 28, 2021

    New changeset 823b3e3 by Miss Islington (bot) in branch '3.10':
    bpo-45612: Add sqlite3 module docstring (GH-29224) (GH-29288)
    823b3e3

    @ambv
    Copy link
    Contributor

    ambv commented Oct 28, 2021

    New changeset d6623c3 by Miss Islington (bot) in branch '3.9':
    bpo-45612: Add sqlite3 module docstring (GH-29224) (GH-29289)
    d6623c3

    @ambv
    Copy link
    Contributor

    ambv commented Oct 28, 2021

    Thanks, Erlend! ✨ 🍰 ✨

    @ambv ambv closed this as completed Oct 28, 2021
    @ambv ambv closed this as completed Oct 28, 2021
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir topic-sqlite3
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants