bazel-contrib / bazel-contrib/rules_python

doc: document current_cc_headers and related targets

Ouverte
#3,098 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
cleanup type: documentation
Langage dominant
Starlark
Étoiles
688
Forks
721
Merge moyen
15 h 7 min
PR mergées (30 j)
76

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Lisez les targets de python/cc/BUILD.bazel, puis examinez toolchains.html dans les sections « python-c-toolchain-type » et « local-toolchain ». Documentez comment les utilisateurs consomment les headers et libpython via la recherche de toolchain, et ajoutez la référence croisée seealso suggérée ; précisez si des targets Python toolchain similaires doivent également être couverts.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
build-system, documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.