cloudevents / cloudevents/sdk-python
Improve the docstring of abstract.CloudEvent
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 342
- Forks
- 65
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
The getitem of this class goes on to describe that:
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
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.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100