Skip to content

Improve subrule documentation #25502

Open
@Ubehebe

Description

@Ubehebe

Page link:

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

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

Bazel 8.0 flipped the --experimental_rule_extension_api flag to true. But this wasn't mentioned in the release notes, and the official documentation 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

Metadata

Metadata

Assignees

Labels

P2We'll consider working on this in future. (Assignee optional)team-DocumentationDocumentation improvements that cannot be directly linked to other team labelsteam-Rules-APIAPI for writing rules/aspects: providers, runfiles, actions, artifactstype: documentation (cleanup)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions