thatlittleboy · GitHub

@Archmonger yea, I agree in spirit that the option names are too long, as proposed. And get where you are coming from. On the other hand, my thinking was that I'ld rather be more explicit in the option names than to keep it short & ambiguous, possibly clashing with other options / confusing users.

Options are specified once, in mkdocs.yml or in the autodocs, the length of the option name is not that big a deal IMO.

TBH, I have a bigger gripe with the fact that, with the introduction of this many new options, how do we properly document and illustrate to the user what the effect of all these options are. And not let them feel overwhelmed by all the options.

ps. on Other parameters, see here: https://mkdocstrings.github.io/griffe/docstrings/#other-parameters

Read the original on github.com ↗