README's "for ... library from Google" text could be confusing?
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 72/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza con el encabezado del README y los metadatos del proyecto que proporcionan la descripción de PyPI; después, verifica la distinción entre la implementación del protocolo Snappy de python-snappy y la biblioteca nativa libsnappy a la que hacen referencia los enlaces. Actualiza ambas descripciones y la explicación final del README para que la relación de dependencia y referencia sea inequívoca.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The python-snappy README and PyPI project description for python-snappy currently say this as their headline:
README:
Python library for the snappy compression library from Google.
PyPI page:
Python bindings for the snappy compression library from Google.
More details about Snappy library: http://google.github.io/snappy
I found this a little confusing when I was trying to figure out python-snappy's dependencies. Especially with the link on the PyPI page going to libsnappy.
python-snappy implements the snappy compression protocol from Google. To me, "the snappy compression library from Google" means the "libsnappy" native/C library Google publishes. (At the google/snappy repo, and packaged as the snappy conda-forge package and libsnappy-* apt packages in Ubuntu etc.). But since https://github.com/intake/python-snappy/pull/130 and python-snappy 0.7.0 or so in Feb 2024, python-snappy uses cramjam instead of libsnappy. (Right?)
Maybe these should say "Python library for the snappy compression protocol from Google" instead? Or "format"? But not "library".
And maybe this thing at the bottom of the README should clarify that it's being used as a reference for the protocol etc., and the implementation library itself is not a dependency or part of python-snappy.
- Lenguaje dominante
- Python
- Estrellas
- 490
- Forks
- 104
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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.
Más de intake/python-snappy
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
intake/python-snappy#151 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
intake/python-snappy#150 · 2 comentarios ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
intake/python-snappy#147 · 3 comentarios ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
intake/python-snappy#140 · 1 comentario · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
intake/python-snappy#138 · 2 comentarios ·
Todos los issues de intake/python-snappy
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
stephrobert/dsoxlab#238 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
sublimehq/package_control#1780 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
nwg-piotr/nwg-displays#145 ·