nimble_options
nimble_options copied to clipboard
Add types to autogenerated schema docs
Hi, this adds options types to the documentation generated with NimbleOptions.docs/2
.
I like this idea. However, I think:
- We should not show anything when the type is
{:custom, ...}
. Let's let the user write it down in the docs. - I don't think we should put backticks around types. I think a good output is
:some_option (integer) - ...
. - You moved the "required" part alongside the type. Let's not do that. A key can be required even if
:type
is not in the schema. Let's revert that change.
Formatting should now be done in the key (type)
and optionally - (Required.) Documentation
format.
Also caught a bug with {:list, subtype}, fixed and added it to the tests. Anything else we should fix?
Last round of changes should be complete.
Thanks @lucacorti! 💟