python / python/cpython

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

Aperta
#99,521 12 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs
Lingua principale
Python
Stelle
77.2k
Fork
36k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla sezione «Built-in Functions» della Python Standard Library documentation ed esamina la notazione delle firme delle funzioni relativa a repr(object, /). Aggiungi una chiave della notazione che spieghi la barra e qualsiasi altra notazione non standard identificata in quella sezione; la documentazione è completa quando i lettori possono comprendere queste firme senza dover cercare altrove.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.