python / python/cpython

Cmd.onecmd documentation is misleading

Abierto
#76,464 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

3.7 (EOL) stdlib
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Merge medio
1 d 9 h
PR fusionados (30 d)
558

Descripción

BPO 32283

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2017-12-12.00:20:54.862>
labels = ['3.7', 'library']
title = 'Cmd.onecmd documentation is misleading'
updated_at = <Date 2017-12-12.00:20:54.862>
user = 'https://bugs.python.org/lyda'

bugs.python.org fields:

activity = <Date 2017-12-12.00:20:54.862>
actor = 'lyda'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2017-12-12.00:20:54.862>
creator = 'lyda'
dependencies = []
files = []
hgrepos = []
issue_num = 32283
keywords = []
message_count = 1.0
messages = ['308082']
nosy_count = 1.0
nosy_names = ['lyda']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue32283'
versions = ['Python 3.6', 'Python 3.7']

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 localizar la documentación de la biblioteca para Cmd.onecmd y compara su redacción con el comportamiento documentado. El issue no identifica ningún archivo ni explica qué texto resulta engañoso, así que determina la aclaración necesaria antes de editar; se considera terminado cuando la documentación describe correctamente Cmd.onecmd y las comprobaciones de la documentación pasan.

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
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.