python / python/cpython

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

Offen
#145,602 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs topic-typing
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Suche in der CPython-Implementierung von typing nach _CallableGenericAlias und dem Docstring von typing.Callable. Überprüfe die Formulierung anhand der Beispiele im Issue und verifiziere anschließend, dass beide Beschreibungen die angeforderte Terminologie für Parameter und Rückgabewerte verwenden; beachte, dass das Issue auf den verknüpften PR gh-145598 verweist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.