bazelbuild / bazelbuild/stardoc

Support a `macro` without a `doc` value but with `inherit_attrs` referring to another `macro` or `rule` inherit that `doc`

Open
#288 4 comments 0 reactions 0 assignees View on GitHub
P3 type: feature request
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

As seen via https://github.com/bazelbuild/stardoc/pull/287, should the lack of a `doc` value to `macro` pick up a value via `inherit_attrs` just like the `attr` values are picked up/merged? i.e. - the lack of a `doc` value, but presents of an `inherit_attrs` also allow the general `docs` to be inherrited?

Contributor guide

Open the contributing guide

Research direction

Review PR #287 and trace the existing handling of macro inherit_attrs for attr and doc values. Confirm the intended behavior for a macro without its own doc value when inherit_attrs points to another macro or rule, and verify that the generated documentation contains the inherited general docs.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.