python / python/cpython

Improve ambiguous docstrings in pkgutil

Abierto
#90,149 9 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs easy type-feature
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Merge medio
1 d 9 h
PR fusionados (30 d)
558

Descripción

BPO 45991
Nosy @barneygale, @slateny

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 2021-12-05.18:56:47.235>
labels = ['easy', '3.9', '3.10', '3.11', 'type-feature', 'docs']
title = 'Improve ambiguous docstrings in pkgutil'
updated_at = <Date 2022-03-01.01:22:11.805>
user = 'https://bugs.python.org/khock'

bugs.python.org fields:

activity = <Date 2022-03-01.01:22:11.805>
actor = 'slateny'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-12-05.18:56:47.235>
creator = 'khock'
dependencies = []
files = []
hgrepos = []
issue_num = 45991
keywords = ['easy']
message_count = 7.0
messages = ['407727', '413883', '413933', '413957', '414076', '414212', '414230']
nosy_count = 4.0
nosy_names = ['docs@python', 'barneygale', 'khock', 'slateny']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45991'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

Linked PRs
  • gh-119252

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

Usa el módulo pkgutil como punto de entrada y revisa los docstrings ambiguos descritos en el issue. Comprueba el PR enlazado gh-119252 antes de empezar, ya que es posible que el trabajo ya esté en curso; se considera terminado cuando la documentación afectada de pkgutil sea más clara.

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.