bazelbuild / bazelbuild/stardoc

Rules don't generate documentation for the "common" attributes (but macros do?)

Open
#286 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

The generated documentation for a "rule" doesn't include all of the common rule attributes, example - https://github.com/bazelbuild/stardoc/blob/master/test/testdata/attribute_types_test/golden.md

But generated documentation for a "macro" can if it uses `inherit_attrs = "common",` (example - https://github.com/bazelbuild/stardoc/blob/master/test/testdata/symbolic_macro_inherit_attrs_test/bazel_8_golden.md#inherit_from_common) or it uses `inherit_attrs = some_rule_reference,`
(example - https://github.com/bazelbuild/stardoc/blob/master/test/testdata/symbolic_macro_inherit_attrs_test/bazel_8_golden.md#inherit_from_rule)

In that second case, the generated docs for `some_rule_reference` won't include those attributes, but the macro will. Shouldn't the "rule" also be generating those or have a way to? i.e. - what do "macro" docs have this extra info, but the "rule" docs don't?

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.