Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support documenting re-exported functions #27

Open
adamtheturtle opened this issue Feb 8, 2021 · 0 comments
Open

Support documenting re-exported functions #27

adamtheturtle opened this issue Feb 8, 2021 · 0 comments

Comments

@adamtheturtle
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant