bazelbuild / bazelbuild/stardoc

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

Open
#202 6 comments 5 reactions 1 assignee Claimed by @tetromino View on GitHub
P3 type: feature request
Dominant language
Java
Stars
118
Forks
51
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.