README's "for ... library from Google" text could be confusing?
- Vorherrschende Sprache
- Python
- Sterne
- 490
- Forks
- 104
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Start with the README headline and the project metadata that supplies the PyPI description, then verify the distinction between python-snappy's Snappy protocol implementation and the native libsnappy library referenced by the links. Update both descriptions and the README's closing explanation so the dependency and reference relationship is unambiguous.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 72/100