python / python/cpython

Mutating a list while iterating: clarify the docs

Open
#76,948 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 32767
Nosy @tim-one, @rhettinger, @terryjreedy, @pochmann, @xgid

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 2018-02-04.19:27:00.850>
labels = ['type-feature', 'docs']
title = 'Mutating a list while iterating:  clarify the docs'
updated_at = <Date 2018-02-11.03:02:24.225>
user = 'https://github.com/tim-one'

bugs.python.org fields:

activity = <Date 2018-02-11.03:02:24.225>
actor = 'tim.peters'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-02-04.19:27:00.850>
creator = 'tim.peters'
dependencies = []
files = []
hgrepos = []
issue_num = 32767
keywords = []
message_count = 6.0
messages = ['311614', '311700', '311735', '311791', '311932', '311977']
nosy_count = 6.0
nosy_names = ['tim.peters', 'rhettinger', 'terry.reedy', 'docs@python', 'Stefan Pochmann', 'xgdomingo']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32767'
versions = ['Python 3.5']

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.

Research direction

Start with the linked BPO issue 32767 and the existing Documentation component context. Review the current Python documentation covering mutation of a list during iteration. Done means the guidance is clarified in the appropriate documentation location and accurately explains the intended behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.