Documented parameter names of some email.utils functions don't match the implementation

Abierto
#161,816 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
20/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

The issue identifies the email.utils documentation and the affected functions: parseaddr(), parsedate(), parsedate_tz(), parsedate_to_datetime(), and mktime_tz(). Compare their documented parameter names with the implementation, then update the docs and check that each name matches; the issue body also lists linked PR gh-161818, so the work may already be underway.

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

Descripción

docs topic-email

Documentation

A few functions in the email.utils docs show a parameter name that differs from the real one. Anyone copying the name from the docs gets a TypeError:

>>> from email.utils import parsedate
>>> parsedate(date='Mon, 20 Nov 1995 19:12:08 -0500')
TypeError: parsedate() got an unexpected keyword argument 'date'. Did you mean 'data'?
>>> parsedate(data='Mon, 20 Nov 1995 19:12:08 -0500')
(1995, 11, 20, 19, 12, 8, 0, 1, -1)
Function Docs Code
parseaddr() address addr
parsedate(), parsedate_tz(), parsedate_to_datetime() date data
mktime_tz() tuple data
Linked PRs
  • gh-161818
Lenguaje dominante
Python
Estrellas
78.2k
Forks
36.6k
Merge medio
19 h 57 min
PR fusionados (30 d)
630

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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.

Más de python/cpython

Todos los issues de python/cpython

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.