Skip to content

Support documenting re-exported functions #27

@adamtheturtle

Description

@adamtheturtle

I have a file example.bzl.

I want my users to load the rule foo from example.bzl - that is the interface I am promising.

foo is defined in other.bzl and exported from example.bzl as follows:

# example.bzl

load(":other.bzl", _foo = "foo")

foo = _foo

I expect to use autobazel-rule to document example.bzl:foo but this errors as the rule is not found.

Instead I have to document other.bzl:foo.
This is problematic as this is not the stable interface.
A title is rendered with other.bzl:foo in it.

My request is that this package is changed either to allow me to document example.bzl:foo, or to allow me to override the title given when I document other.bzl:foo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions