python / python/cpython

`_CallableGenericAlias` class and `typing.Callable` docstring should be corrected

Open
#145,602 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Documentation

*Notes:

  • Python 3.14.3
  • Related: #145577

_CallableGenericAlias class should be corrected for example:

Represent `Callable[argtypes, resulttype]`. -> Represent `Callable[paramtypes, returntype]`.

t_args, t_result = args -> t_params, t_return = args

typing.Callable docstring should be corrected for example:

a function that takes a single parameter -> a function that has a single parameter

... to indicate optional or keyword arguments; -> ... to indicate optional or keyword parameters;
Linked PRs
  • gh-145598

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 by searching the CPython typing implementation for _CallableGenericAlias and the typing.Callable docstring. Check the wording against the examples in the issue, then verify that both descriptions use the requested parameter and return terminology; note that the issue references linked PR gh-145598.

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.