bazel-contrib / bazel-contrib/rules_python

doc: document current_cc_headers and related targets

オープン
#3,098 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
cleanup type: documentation
主要言語
Starlark
スター
688
フォーク
721
平均マージ
15時間 7分
マージ済み PR(30日)
76

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

python/cc/BUILD.bazel のターゲットを読み、その後 toolchains.html の「python-c-toolchain-type」セクションと「local-toolchain」セクションを確認してください。ユーザーが toolchain の検索を通じて headers と libpython をどのように利用するかを文書化し、提案されている seealso の相互参照を追加してください。類似する Python toolchain ターゲットも対象に含めるべきかどうかを明確にしてください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
build-system, documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。