bazel-contrib / bazel-contrib/rules_python

doc: document current_cc_headers and related targets

Đang mở
#3,098 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
cleanup type: documentation
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ả

This is a ticket to document the targets in https://github.com/bazel-contrib/rules_python/blob/cab415d82ebbfd1b8b2d81ef61baf3f9a274a1b2/python/cc/BUILD.bazel#L15 and other in the same file so that we can point users to documentation on how to use toolchain lookup instead of the legacy alias targets in toolchain repos that we are still creating.

Maybe this ticket can also document similar targets for the python toolchain as well.

EDIT: Looked at the docs again and I see that the easiest way to document this would be to add a sentence or two in https://rules-python.readthedocs.io/en/latest/toolchains.html#python-c-toolchain-type so that the users know how to consume headers and `libpython`.

Cross-referencing https://rules-python.readthedocs.io/en/latest/toolchains.html#local-toolchain with `seealso` to the `python-c-toolchain-type` would be also useful.

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

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Đọc các target trong python/cc/BUILD.bazel, sau đó xem lại toolchains.html tại các phần “python-c-toolchain-type” và “local-toolchain”. Ghi lại cách người dùng sử dụng headers và libpython thông qua việc tra cứu toolchain, đồng thời thêm tham chiếu chéo seealso được đề xuất; làm rõ liệu các target Python toolchain tương tự cũng nên được đề cập hay không.

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, documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
55/100

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.