python / python/cpython

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

Abierto
#99,521 12 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza por la sección «Built-in Functions» de la Python Standard Library documentation y revisa la notación de las firmas de función en torno a repr(object, /). Añade una clave de notación que explique la barra y cualquier otra notación no estándar identificada allí; la documentación estará terminada cuando los lectores puedan entender estas firmas sin tener que buscar en otro lugar.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.