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

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

Open
tetromino opened this issue Mar 29, 2024 · 2 comments
Open

Comments

@tetromino
Copy link
Collaborator

tetromino commented Mar 29, 2024

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

@aaronsky
Copy link

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?

@tetromino
Copy link
Collaborator Author

@aaronsky - yes.

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

No branches or pull requests

2 participants