Closed tetromino closed 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:~
init
callback's summary docstring is not interesting to the user (it's along the lines of "Validates params foo and bar") - so we should not render it. The provider's docstring is the interesting part for the user.~
init
callback exactly matches the list of fields. If that is so, we should merge parameters and fields into a single table.~init
parameters is different from fields, we should propagate docstrings from fields to undocumented init parameters with the same name.~~In other words, fairly extensive munging of the ProviderInfo proto is necessary.~
I think by default, we want the following behavior:
If a provider has a custom
init
callback, we want the summary blurb to showinit
'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