bazelbuild / stardoc

Stardoc: Starlark Documentation Generator
Apache License 2.0
107 stars 42 forks source link

Render documentation for provider `init` callbacks #224

Closed tetromino closed 4 months ago

tetromino commented 4 months ago

If a provider has a custom init callback, we want the summary blurb to show init's parameters (since these are what the user will interact with); we have to render constructor paramaters and fields separately (and using separate html anchors) since there is not necessarily a 1-1 relationship between them, and since they may have different docs.

Fixes #182

tetromino commented 4 months ago

~Current PR is not ready. I need to fix the following problems which occurred to me in the process of testing it:~

~In other words, fairly extensive munging of the ProviderInfo proto is necessary.~

tetromino commented 4 months ago

I think by default, we want the following behavior: