You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We generate API docs for bazel build language objects which include a doc field (such as rules, providers, and aspects) or have a docstring set by convention (modules, functions); but we do not document any other Starlark values such as strings, lists, tuples, dicts, or structs.
However, .bzl files frequently define string/list/etc. constants as part of their API, and documenting them would seem a good idea.
did a little bit of research for this just now. not super familiar with the code, but i don't see anything in the proto that would give us this information. so maybe this requires changes to bazel first?
We generate API docs for bazel build language objects which include a doc field (such as rules, providers, and aspects) or have a docstring set by convention (modules, functions); but we do not document any other Starlark values such as strings, lists, tuples, dicts, or structs.
However, .bzl files frequently define string/list/etc. constants as part of their API, and documenting them would seem a good idea.
Prior art in Python land: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-autoattribute
The text was updated successfully, but these errors were encountered: