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

str.join() should be documented as taking an iterable #51365

Closed
jessaustin mannequin opened this issue Oct 12, 2009 · 2 comments
Closed

str.join() should be documented as taking an iterable #51365

jessaustin mannequin opened this issue Oct 12, 2009 · 2 comments
Assignees
Labels
docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) type-bug An unexpected behavior, bug, or error

Comments

@jessaustin
Copy link
Mannequin

jessaustin mannequin commented Oct 12, 2009

BPO 7116
Nosy @birkenfeld
Files
  • jointakesiterables.diff: patch to doc strings and stdtypes documentation
  • 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 = 'https://github.com/birkenfeld'
    closed_at = <Date 2009-10-14.18:48:41.640>
    created_at = <Date 2009-10-12.22:37:39.899>
    labels = ['interpreter-core', 'type-bug', 'docs']
    title = 'str.join() should be documented as taking an iterable'
    updated_at = <Date 2009-10-14.18:48:41.639>
    user = 'https://bugs.python.org/jessaustin'

    bugs.python.org fields:

    activity = <Date 2009-10-14.18:48:41.639>
    actor = 'georg.brandl'
    assignee = 'georg.brandl'
    closed = True
    closed_date = <Date 2009-10-14.18:48:41.640>
    closer = 'georg.brandl'
    components = ['Documentation', 'Interpreter Core']
    creation = <Date 2009-10-12.22:37:39.899>
    creator = 'jess.austin'
    dependencies = []
    files = ['15111']
    hgrepos = []
    issue_num = 7116
    keywords = ['patch']
    message_count = 2.0
    messages = ['93909', '94009']
    nosy_count = 2.0
    nosy_names = ['georg.brandl', 'jess.austin']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = None
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue7116'
    versions = ['Python 2.6', 'Python 2.5', 'Python 2.4', 'Python 3.0', 'Python 3.1', 'Python 2.7']

    @jessaustin
    Copy link
    Mannequin Author

    jessaustin mannequin commented Oct 12, 2009

    In its __doc__ string and in the documentation, str.join() is described
    as taking a sequence. This is not general enough; it actually takes any
    iterable of strings:

        >>> ','.join(str(x) for x in range(5))
        '0,1,2,3,4'

    Maybe this is a small nit to pick, but it slowed me down for a few
    minutes, and I already vaguely remembered that str.join() could handle
    iterables.

    @jessaustin jessaustin mannequin assigned birkenfeld Oct 12, 2009
    @jessaustin jessaustin mannequin added docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) type-bug An unexpected behavior, bug, or error labels Oct 12, 2009
    @birkenfeld
    Copy link
    Member

    Thanks, fixed in r75418.

    @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
    docs Documentation in the Doc dir interpreter-core (Objects, Python, Grammar, and Parser dirs) type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant