README's "for ... library from Google" text could be confusing?

Đang mở Phù hợp với người mới
#152 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với tiêu đề README và siêu dữ liệu của dự án cung cấp phần mô tả trên PyPI, sau đó xác minh sự khác biệt giữa phần triển khai giao thức Snappy của python-snappy và thư viện libsnappy native được các liên kết tham chiếu. Cập nhật cả hai phần mô tả và phần giải thích ở cuối README để mối quan hệ về dependency và reference là không thể hiểu nhầm.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Image

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.

Image
Ngôn ngữ chính
Python
Star
490
Fork
104
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của intake/python-snappy

Tất cả issue của intake/python-snappy

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.