python / python/cpython

Slash notation should be defined in a notation key at the beginning of the Built-In Functions section

Offen
#99,521 12 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Documentation

The Standard Library defines a number of built-in functions, and a shorthand notation is used when a function is defined, such as the definition of repr:

repr(object, /)

But there is no information about what that "/' means in the function signature. It is not standard computer science notation, so I started looking for its meaning. Normally, a notation key should be at the beginning of the document or section, but I do not find a notation key either at the beginning of the section or at the beginning of the documentation.

Could a notation key be added please, to define the meaning of this and any other non-standard notation that is used in the Python documentation?

Linked PRs
  • gh-142641

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

Beginnen Sie mit dem Abschnitt „Built-in Functions“ der Python Standard Library documentation und prüfen Sie die Notation der Funktionssignaturen rund um repr(object, /). Fügen Sie einen Notationsschlüssel hinzu, der den Schrägstrich und jede andere dort identifizierte nicht standardmäßige Notation erklärt; die Dokumentation ist fertig, wenn Leser diese Signaturen verstehen können, ohne anderswo suchen zu müssen.

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
25/100

Neue Issues direkt in Ihr Postfach

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