bazelbuild / bazelbuild/stardoc
FR: Add support for documenting Starlark-defined transitions
Open
P4
type: feature request
- Dominant language
- Java
- Stars
- 118
- Forks
- 51
- PR merge metrics
- No merged PRs in 30d
Description
Starlark-defined transitions are defined with the `transition` function, which does not have a `doc` parameter. The FR is to add that to Bazel and support it in stardoc.
Contributor guide
Research direction
Start by reading Bazel's Starlark transition documentation and Stardoc's handling of the `transition` function. Done means the function accepts a `doc` parameter and Stardoc includes that documentation in generated output, with the relevant behavior verified by the project's tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100