bazelbuild / bazelbuild/stardoc

Wrapping a rule with a macro of the same name prevents the rule from being documented

Open
#98 2 comments 0 reactions 0 assignees View on GitHub
P4 type: bug
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

One pattern in use in repos is to override a rule with a macro so that additional targets can be generated without needing to rewrite existing callers. An example of this approach [can be seen in this PR](https://github.com/bazelbuild/rules_kotlin/pull/529).

`stardoc` will document the macro, but will not find the wrapped rule, and so will not correctly document the project.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the wrapped-rule and same-name macro pattern described in the issue, using the linked rules_kotlin PR as the example. Then trace how stardoc discovers and documents rules versus macros; done means the wrapped rule is documented correctly alongside the macro.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, devtools, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.