bazelbuild / bazelbuild/stardoc

Controls for the inclusion of the common attributes

Open
#292 1 comment 0 reactions 1 assignee Claimed by @tetromino View on GitHub
P3 type: feature request
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

This sorta goes with #286.

Since `macros` already auto include the common attributes in their documentation, it would be nice to have some controls over that.

For example
- a test rule might not actually support sharding, so while those attributes are _valid_, they have no meaning and can just result in clutter for someone trying to read the rule/macro attributes.
- likewise, things like `args` for a test rule might not really apply to running a test, so skipping those could be good.

Another potential options would be instead of adding controls for showing/hiding of things, to maybe present the common attributes differently. Maybe if while iterating over the attributes one could tell if it as a common one or rule/macro specific, the listing could be split into two, an initial table of the rule/macro specific attributes, and then second table of the common ones? Or maybe don't even list the common one in the table, but have the overview link them directly out to some common definitions document instead so the table developers read is only the rule/macro specific things?

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.