stardoc icon indicating copy to clipboard operation
stardoc copied to clipboard

Docstrings for top-level constant values (strings, lists, dicts, structs)

Open tetromino opened this issue 2 years ago • 3 comments

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

tetromino avatar Mar 29 '24 20:03 tetromino

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?

aaronsky avatar May 15 '24 21:05 aaronsky

@aaronsky - yes.

tetromino avatar May 20 '24 19:05 tetromino