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.

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

Misleading documentation for tuple #83293

Closed
SimonBerens mannequin opened this issue Dec 21, 2019 · 4 comments
Closed

Misleading documentation for tuple #83293

SimonBerens mannequin opened this issue Dec 21, 2019 · 4 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@SimonBerens
Copy link
Mannequin

SimonBerens mannequin commented Dec 21, 2019

BPO 39112
Nosy @terryjreedy, @tirkarthi, @SimonBerens
Superseder
  • bpo-34118: Fix some class entries in 'Built-in Functions'
    		•

    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 2019-12-28.22:05:03.631>
created_at = <Date 2019-12-21.01:28:19.210>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Misleading documentation for tuple'
updated_at = <Date 2019-12-28.22:05:03.630>
user = 'https://github.com/SimonBerens'

    bugs.python.org fields:

    activity = <Date 2019-12-28.22:05:03.630>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-12-28.22:05:03.631>
closer = 'terry.reedy'
components = ['Documentation']
creation = <Date 2019-12-21.01:28:19.210>
creator = 'sberens'
dependencies = []
files = []
hgrepos = []
issue_num = 39112
keywords = []
message_count = 4.0
messages = ['358753', '358809', '358932', '358933']
nosy_count = 4.0
nosy_names = ['terry.reedy', 'docs@python', 'xtreak', 'sberens']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = 'resolved'
status = 'closed'
superseder = '34118'
type = 'enhancement'
url = 'https://bugs.python.org/issue39112'
versions = ['Python 2.7', 'Python 3.7', 'Python 3.8', 'Python 3.9']
    @SimonBerens
    Copy link
    Mannequin Author

    SimonBerens mannequin commented Dec 21, 2019

    Sorry if this is a silly question (my first bug report), but it seems that https://docs.python.org/3/library/functions.html#func-tuple
    should say "class tuple" instead of just "tuple", as list, dict, and set do.

    @SimonBerens SimonBerens mannequin added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Dec 21, 2019
    @SimonBerens SimonBerens mannequin assigned docspython Dec 21, 2019
    @SimonBerens SimonBerens mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement 3.8 only security fixes 3.9 only security fixes labels Dec 21, 2019
    @SimonBerens SimonBerens mannequin assigned docspython Dec 21, 2019
    @SimonBerens SimonBerens mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Dec 21, 2019
    @tirkarthi
    Copy link
    Member

    FWIW, built-in types page has the class prefix : https://docs.python.org/3/library/stdtypes.html#tuple . Similar difference between range in the two pages.

    @terryjreedy
    Copy link
    Member

    I believe that this is a duplicate issue. As noted before, filter, map, reversed, and zip are classes, but they return iterators and are documented differently.

    @tirkarthi
    Copy link
    Member

    Thanks Terry, I guess it's a duplicate of bpo-34118 .

    @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
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @tirkarthi @terryjreedy