Skip to content

Symbolic Macros should generate docs pretty much exactly like rules #285

Description

@thomasvl

Symbolic Macros (https://bazel.build/extending/macros) seems like they are meant to cover the case where you really want to create a "rule", but is easier to actually compose it out of one or more other rules. But the generated documentation leaks this details, it calls out that it is a "macro" and not a "rule", but why should the users of the thing care? They should be treating it just like a rule.

  • The generated docs for name calls out it is a macro vs a rule.
  • The generated docs for name also calls out there could be multiple subtargets, but isn't that an implementation detail?
  • The summary block for the macro includes the * before the name, why? Since everything has to be named like a rule, why is this needed? A rule's docs don't include a *?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions