bazel-contrib / bazel-contrib/rules_python
`py_wheel`: Summary, Description, Description-Content-Type
- Ngôn ngữ chính
- Starlark
- Star
- 688
- Fork
- 721
- Merge trung bình
- 15 giờ 7 phút
- Pull request đã merge (30 ngày)
- 76
Mô tả
# 🚀 feature request and documentation 🐞 bug report
### Relevant Rules
`py_wheel`
### Description
The documentation of the `description_file` attribute of `py_wheel` describes the attribute as "A file containing text describing the package in a single line."
This directly contradicts the core metadata specifications, https://packaging.python.org/en/latest/specifications/core-metadata/#description, which states
> A longer description of the distribution that can run to several paragraphs. Software that deals with metadata should not assume any maximum size for this field, though people shouldn’t include their instruction manual as the description.
There is, however, another field in the core metadata specifications that actually matches the description, https://packaging.python.org/en/latest/specifications/core-metadata/#summary:
> Summary
> A one-line summary of what the distribution does.
I'm not entirely sure if this should be a bug report or a feature request, because both "Description" and "Summary" would be nice to have. I'm assuming that compliance with the [PyPA specifications](https://packaging.python.org/en/latest/specifications/) is intended, in which case it is at least a documentation bug. The `description_file` attribute ends up as the "Description", and can be several paragraphs. But it would be nice to also support the "Summary" field using a different attribute, and it would also be nice to be able to set the "Description-Content-Type field, https://packaging.python.org/en/latest/specifications/core-metadata/#description-content-type, so at least in those parts it's a feature request as well.
### Describe the solution you'd like
1. Documentation of `description_file` updated to support more than one line of description.
2. New attribute `summary` for the one-line description, setting [Summary](https://packaging.python.org/en/latest/specifications/core-metadata/#summary)
3. New attribute `description_content_type` for specifying markup syntax, setting [Description-Content-Type](https://packaging.python.org/en/latest/specifications/core-metadata/#description-content-type)
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu từ rule `py_wheel` và theo dõi cách `description_file` được ghi lại trong tài liệu và ánh xạ vào siêu dữ liệu lõi của Python. So sánh hành vi đó với các đặc tả Summary, Description và Description-Content-Type được liên kết, sau đó xác minh rằng tài liệu và ba thuộc tính siêu dữ liệu được yêu cầu hoạt động như mô tả.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- build-system
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 68/100