bazel-contrib / bazel-contrib/rules_python
doc: document current_cc_headers and related targets
- Vorherrschende Sprache
- Starlark
- Sterne
- 688
- Forks
- 721
- Ø Merge
- 15 Std. 7 Min.
- Gemergte PRs (30 T.)
- 76
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
Lies die Targets in python/cc/BUILD.bazel und prüfe anschließend toolchains.html in den Abschnitten „python-c-toolchain-type“ und „local-toolchain“. Dokumentiere, wie Nutzer Header und libpython über die Toolchain-Suche nutzen, und füge den vorgeschlagenen seealso-Querverweis hinzu; kläre, ob ähnliche Python-Toolchain-Targets ebenfalls abgedeckt werden sollten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- build-system, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 55/100