python / python/cpython

Tutorial 4.8 call by value vs reference is confusing

Open
#148,542 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Documentation

The part about how arguments are passed in Section 4.8 (by value vs by reference) is written in a confusing way and there is even a footnote admitting to it

IMO an improvement would be along the lines:
Arguments are always passed using call by value. For objects that are passed this value consists of a reference to that object. Which means that mutations to the object are visible outside, reassignments of another reference to the variable inside the function are not. insert example

Linked PRs
  • gh-148563

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

Read Section 4.8 of the Python tutorial at docs.python.org/3/tutorial/controlflow.html#defining-functions, including its footnote, and review linked PR gh-148563. Done means the call-by-value versus reference explanation is clearer and includes an example showing mutation versus reassignment.

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
Clearly specified
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.