bazelbuild / bazelbuild/stardoc
Autodocument enumerated "values" of rule/aspect attributes
Open
P4
type: feature request
- Dominant language
- Java
- Stars
- 118
- Forks
- 51
- PR merge metrics
- No merged PRs in 30d
Description
Consider the following rule attribute definition:
```
"format": attr.string(
doc = "The format of the output file.",
default = "markdown",
values = ["markdown", "proto"],
),
```
It would be best if Stardoc documented the available values for "format" automatically.
Contributor guide
Research direction
Begin by locating Stardoc's handling of rule and aspect attributes, using the example `format` attribute as the starting case. Done means generated documentation automatically lists the allowed values `markdown` and `proto` for an attribute whose definition supplies a `values` list.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100