bazel-contrib / bazel-contrib/rules_python

doc: document current_cc_headers and related targets

Aperta
#3,098 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
cleanup type: documentation
Lingua principale
Starlark
Stelle
688
Fork
721
Merge medio
15h 7m
PR unite (30g)
76

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Read the targets in python/cc/BUILD.bazel, then review toolchains.html at the “python-c-toolchain-type” and “local-toolchain” sections. Document how users consume headers and libpython through toolchain lookup, and add the suggested seealso cross-reference; clarify whether similar Python toolchain targets should also be covered.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
build-system, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.