README's "for ... library from Google" text could be confusing?
- Lenguaje dominante
- Python
- Estrellas
- 490
- Forks
- 104
- Métricas de merge de PR
- Sin PR fusionados en 30 d
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](https://pypi.org/project/python-snappy/):
> Python bindings for the snappy compression library from Google.
>
> More details about Snappy library: [http://google.github.io/snappy](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](https://github.com/google/snappy), and packaged as the [`snappy` conda-forge package](https://anaconda.org/channels/conda-forge/packages/snappy/overview) 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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 72/100