Support a nesting level in NimbleOptions.docs/2 #57
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The nesting level allows to nest all options in the generated
Markdown by the given level. This allows to have, for example,
a nested "nested_schema" schema and use NimbleOptions.docs/2
inside the documentation for another option:
main_schema = [
my_key: [
type: {:or, [:string, keyword_list: nested_schema]},
doc: """
Either a string or a keyword list with keys:
#{NimbleOptions.docs(nested_schema, _nest_level = 1)}
"""
]
]
The options for the nested schema in ":my_key" will be nested by
one level, producing the correct Markdown.
|
Can we make it a keyword list? I am sure we will want other options in the future and the fact we are using a variable probably means we should use a keyword list anyway. :D |
|
@josevalim good call, didn't think about it. Updated! |
josevalim
approved these changes
Nov 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The nesting level allows to nest all options in the generated Markdown by the given level. This allows to have, for example, a nested
nested_schemaschema and useNimbleOptions.docs/2inside the documentation for another option:The options for the nested schema in
:my_keywill be nested by one level, producing the correct Markdown.