Tutorial offers dangerous advice about iterators: “__iter__() can just return self”

Open
#52,623 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Read the tutorial's iterator guidance and the attached issue8376.patch first; the payload does not name the documentation file. Confirm what the statement about iter() returning self implies, then update the tutorial so the advice is accurate and verify the resulting documentation wording.

Written by the indexing model from the issue text.

Description

docs type-bug
BPO 8376
Nosy @birkenfeld, @rhettinger, @terryjreedy, @amauryfa, @pitrou, @merwok, @bitdancer, @andersk, @Usui22750
Files
  • issue8376.patch
  • 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 = None
    created_at = <Date 2010-04-12.06:35:57.093>
    labels = ['type-bug', '3.7', 'docs']
    title = 'Tutorial offers dangerous advice about iterators: \xe2\x80\x9c__iter__() can just return self\xe2\x80\x9d'
    updated_at = <Date 2017-07-13.12:29:41.820>
    user = 'https://github.com/andersk'
    

    bugs.python.org fields:

    activity = <Date 2017-07-13.12:29:41.820>
    actor = 'r.david.murray'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2010-04-12.06:35:57.093>
    creator = 'andersk'
    dependencies = []
    files = ['45088']
    hgrepos = []
    issue_num = 8376
    keywords = ['patch']
    message_count = 16.0
    messages = ['102918', '102951', '102955', '102961', '102963', '102966', '111155', '111196', '111197', '111198', '111201', '278638', '278640', '278641', '278805', '298280']
    nosy_count = 10.0
    nosy_names = ['georg.brandl', 'rhettinger', 'terry.reedy', 'amaury.forgeotdarc', 'pitrou', 'eric.araujo', 'r.david.murray', 'ysj.ray', 'andersk', 'Usui']
    pr_nums = []
    priority = 'low'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue8376'
    versions = ['Python 3.6', 'Python 3.7']
    

    Dominant language
    Python
    Stars
    77.2k
    Forks
    36k
    Avg merge
    1d 9h
    Merged PRs (30d)
    558

    Contributor guide

    Open the contributing guide

    First steps

    1. Read the whole issue, then the project's contributing guide.
    2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
    3. Fork the repository and make your change on a branch.
    4. Open a pull request that references the issue number.

    More from python/cpython

    All issues in python/cpython

    Similar issues

    More Python issues

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.