bazelbuild / bazelbuild/bazel

Improve subrule documentation

Open
#25,502 1 comment 1 reaction 1 assignee Claimed by @hvadehra View on GitHub
P2 team-Documentation team-Rules-API type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

### Page link:

https://bazel.build/rules/lib/builtins/Subrule

### Problem description (include actual vs expected text, if applicable):

Bazel 8.0 [flipped](https://github.com/bazelbuild/bazel/commit/80d8e4253332961b703f67c0b33e6e6f803dd5b7) the `--experimental_rule_extension_api` flag to true. But this wasn't mentioned in the [release notes](https://github.com/bazelbuild/bazel/releases/tag/8.0.0), and the official [documentation](https://bazel.build/rules/lib/builtins/Subrule) for subrules just points to the design doc.

I've found subrules to be a valuable way to structure my Starlark code, and I use dozens of them in my Bazel repo. I'd like subrules to be better supported/documented across the Bazel ecosystem. This includes documenting the subrule API, but also providing APIs for documenting subrules themselves. (Currently, starlark_doc_extract ignores subrules.)

### Where do you see this issue? (include link to specific section of the page, if applicable)

_No response_

### Any other information you'd like to share?

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.