Improve the docstring of abstract.CloudEvent

Abierto
#247 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Abre cloudevents/abstract/event.py alrededor de las líneas 99-100 e inspecciona el docstring de getitem. Lee el issue #246 para conocer la confusión reportada sobre el acceso a los datos privados de _attributes. Se considera terminado cuando el docstring explique por qué no se recomienda event.get() e incluya un ejemplo útil o una referencia.

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

Descripción

The getitem of this class goes on to describe that:

https://github.com/cloudevents/sdk-python/blob/c5645d8fcf03432639727b9a7f6508c3059a1673/cloudevents/abstract/event.py#L99-L100

providing a reason and perhaps a reference to an example would help developers understand why event.get() is discouraged by this helper method.

For instance, there is confusion in how the private _attributes data should be accessed expressed in https://github.com/cloudevents/sdk-python/issues/246.

Lenguaje dominante
Python
Estrellas
342
Forks
65
Sin PR fusionados en 30 d

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.

Más de cloudevents/sdk-python

Todos los issues de cloudevents/sdk-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.