python / python/cpython

Update function signatures to use `*` and `/` as needed

Open
#131,885 9 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

[!CAUTION]
For new contributors, please do not consider this issue as an "easy" one. While the changes may seem mechanical, they are not necessarily trivial as this requires to know what really happens (both at a Python and a C level).

This is tracks cases where changes need to be made to enact the Editorial Board's decision for function signature markup.

  • builtins:
    • min()
    • max()
    • range()
    • map()
  • methods on builtins:
    • dict.get(), dict.setdefault()

See also:

Linked PRs
  • gh-131868
  • gh-131886
  • gh-128208
  • gh-131893
  • gh-131894
  • gh-131990
  • gh-131992
  • gh-132029
  • gh-136085
  • gh-136120
  • gh-136121
  • gh-137656
  • gh-137657
  • gh-137902
  • gh-137904
  • gh-139978
  • gh-140270
  • gh-144856
  • gh-156179
  • gh-156267
  • gh-156268
  • gh-156269

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 remaining unchecked map() item and review the function-signature guidance and linked Editorial Board discussions. Inspect the relevant built-in documentation and existing linked PRs; the work is done when the applicable signatures consistently use * and / according to the agreed markup.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.