python-hyper / python-hyper/brotlicffi

Rather outdated docs on RTD

Abierto
#217 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
154
Forks
34
Merge medio
1 d 1 h
PR fusionados (30 d)
3

Descripción

I just had a look at the docs to see whether decompressing would allow specifying an output limit, which did not appear to be the case: https://python-hyper.org/projects/brotlipy/en/latest/api.html#brotli.Decompressor.decompress

According to the changelog, this has been changed and released a few days ago, but according to the build history, the RTD docs have not been generated for over seven years, thus these new options are missing: https://app.readthedocs.org/projects/brotlipy/builds/

By the way: The docs seem to still be under the old name which has been changed a few years ago, which is a bit confusing as well.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 inspeccionando la configuración de Read the Docs y la fuente de documentación de la página de API enlazada en la issue; después, compárala con el changelog y el nombre actual del proyecto. Confirma cómo está configurada la compilación de la documentación y actualiza la documentación publicada para que se reflejen las nuevas opciones de descompresión y el nombre actual.

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
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.