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

Turtle: invalid example for write doc #90030

Closed
willyns mannequin opened this issue Nov 22, 2021 · 2 comments
Closed

Turtle: invalid example for write doc #90030

willyns mannequin opened this issue Nov 22, 2021 · 2 comments
Labels
3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@willyns
Copy link
Mannequin

willyns mannequin commented Nov 22, 2021

BPO 45872
Nosy @merwok
Superseder
  • bpo-45397: turtle.write doc missing tuple parens for font default in 3.10+
  • 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-11-27.02:53:31.593>
    created_at = <Date 2021-11-22.17:35:35.968>
    labels = ['3.11', 'type-bug', '3.10', 'docs']
    title = 'Turtle: invalid example for write doc'
    updated_at = <Date 2021-11-27.02:53:31.592>
    user = 'https://bugs.python.org/willyns'

    bugs.python.org fields:

    activity = <Date 2021-11-27.02:53:31.592>
    actor = 'terry.reedy'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2021-11-27.02:53:31.593>
    closer = 'terry.reedy'
    components = ['Documentation']
    creation = <Date 2021-11-22.17:35:35.968>
    creator = 'willyns'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 45872
    keywords = []
    message_count = 2.0
    messages = ['406795', '407086']
    nosy_count = 3.0
    nosy_names = ['eric.araujo', 'docs@python', 'willyns']
    pr_nums = []
    priority = 'normal'
    resolution = 'duplicate'
    stage = 'resolved'
    status = 'closed'
    superseder = '45397'
    type = 'behavior'
    url = 'https://bugs.python.org/issue45872'
    versions = ['Python 3.10', 'Python 3.11']

    @willyns
    Copy link
    Mannequin Author

    willyns mannequin commented Nov 22, 2021

    There are no parentheses for 'font' argument in turtle.write() documentation

    https://docs.python.org/3.10/library/turtle.html#turtle.write

    @willyns willyns mannequin added the 3.10 only security fixes label Nov 22, 2021
    @willyns willyns mannequin assigned docspython Nov 22, 2021
    @willyns willyns mannequin added docs Documentation in the Doc dir 3.10 only security fixes labels Nov 22, 2021
    @willyns willyns mannequin assigned docspython Nov 22, 2021
    @willyns willyns mannequin added the docs Documentation in the Doc dir label Nov 22, 2021
    @merwok
    Copy link
    Member

    merwok commented Nov 26, 2021

    The doc for the font parameter is: a triple (fontname, fontsize, fonttype)
    but the default value in the signature is: font='Arial'

    I do not know what’s font name vs font type!
    Do you know if it’s valid to have font='Arial', in which case the doc should be amended? or is the default value wrong? (also not sure if it’s a default value or an example)

    @merwok merwok changed the title Turtle documentation, write() Turtle: invalid example for write doc Nov 26, 2021
    @merwok merwok changed the title Turtle documentation, write() Turtle: invalid example for write doc Nov 26, 2021
    @terryjreedy terryjreedy added the 3.11 only security fixes label Nov 27, 2021
    @terryjreedy terryjreedy added type-bug An unexpected behavior, bug, or error 3.11 only security fixes labels Nov 27, 2021
    @terryjreedy terryjreedy added the type-bug An unexpected behavior, bug, or error label Nov 27, 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.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants