Skip to content
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

Docstring convention not followed for dataclasses documentation page #85371

Closed
JackStraw mannequin opened this issue Jul 3, 2020 · 6 comments
Closed

Docstring convention not followed for dataclasses documentation page #85371

JackStraw mannequin opened this issue Jul 3, 2020 · 6 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes docs Documentation in the Doc dir easy type-feature A feature request or enhancement

Comments

@JackStraw
Copy link
Mannequin

JackStraw mannequin commented Jul 3, 2020

BPO 41199
Nosy @ericvsmith, @srinivasreddy, @miss-islington, @marload
PRs
  • bpo-41199: Docstring convention not followed for dataclasses documentation page #21413
  • [3.9] bpo-41199: Docstring convention not followed for dataclasses documentation page (GH-21413) #21414
  • [3.8] bpo-41199: Docstring convention not followed for dataclasses documentation page (GH-21413) #21415
  • 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 2020-07-09.12:19:25.284>
    created_at = <Date 2020-07-03.01:10:13.440>
    labels = ['easy', '3.7', '3.8', '3.9', '3.10', 'type-feature', 'docs']
    title = 'Docstring convention not followed for dataclasses documentation page'
    updated_at = <Date 2020-07-09.12:21:15.430>
    user = 'https://bugs.python.org/JackStraw'

    bugs.python.org fields:

    activity = <Date 2020-07-09.12:21:15.430>
    actor = 'miss-islington'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2020-07-09.12:19:25.284>
    closer = 'eric.smith'
    components = ['Documentation']
    creation = <Date 2020-07-03.01:10:13.440>
    creator = 'JackStraw'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 41199
    keywords = ['patch', 'newcomer friendly']
    message_count = 6.0
    messages = ['372899', '373377', '373378', '373395', '373397', '373398']
    nosy_count = 7.0
    nosy_names = ['eric.smith', 'docs@python', 'python-dev', 'thatiparthy', 'miss-islington', 'JackStraw', 'ys19991']
    pr_nums = ['21413', '21414', '21415']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue41199'
    versions = ['Python 3.7', 'Python 3.8', 'Python 3.9', 'Python 3.10']

    @JackStraw
    Copy link
    Mannequin Author

    JackStraw mannequin commented Jul 3, 2020

    The InventoryItem class on the dataclasses page [https://docs.python.org/3.7/library/dataclasses.html#module-dataclasses] has single quotes for the docstring, as opposed to double quotes (as described by PEP-257.

    @JackStraw JackStraw mannequin added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes labels Jul 3, 2020
    @JackStraw JackStraw mannequin assigned docspython Jul 3, 2020
    @JackStraw JackStraw mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes labels Jul 3, 2020
    @JackStraw JackStraw mannequin assigned docspython Jul 3, 2020
    @JackStraw JackStraw mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Jul 3, 2020
    @marload
    Copy link
    Mannequin

    marload mannequin commented Jul 9, 2020

    May I solve this issue?

    @srinivasreddy
    Copy link
    Mannequin

    srinivasreddy mannequin commented Jul 9, 2020

    Please go ahead and create a PR.

    @miss-islington
    Copy link
    Contributor

    New changeset 61bb24a by marload in branch 'master':
    bpo-41199: Docstring convention not followed for dataclasses documentation page (GH-21413)
    61bb24a

    @miss-islington
    Copy link
    Contributor

    New changeset b4beda1 by Miss Islington (bot) in branch '3.9':
    bpo-41199: Docstring convention not followed for dataclasses documentation page (GH-21413)
    b4beda1

    @miss-islington
    Copy link
    Contributor

    New changeset 1e66f7e by Miss Islington (bot) in branch '3.8':
    bpo-41199: Docstring convention not followed for dataclasses documentation page (GH-21413)
    1e66f7e

    @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.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes docs Documentation in the Doc dir easy type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants