Fine grain config #289
Draft
Fine grain config #289
Conversation
This file contains hidden or 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
This change allows users to specify recursive options under `members`:
```
::: some.module
options:
members:
- name: SomeName
options:
heading: Some Verbose Name
members:
- ...
```
This change also brings a refactor in how we combine default, global and
local configuration. Instead of keeping track of dictionaries to merge
them accordingly, we now chain dataclasses together, using a special
`UNSET` value to tell whether an option was set or not. Checking against
this `UNSET` value lets the chained dataclass know whether it should
try to fetch the value from previous (left/up) dataclasses.
With the following example chain:
```
{ some_option: UNSET } -> { some_option: False } -> { some_option: UNSET
}
```
...trying to get `some_option` from the chain would start with the
right-most dataclass, where `some_option` is `UNSET`. Then it would
continue on the left, and return `False` since it's not `UNSET`. The
left-most dataclass would not be checked since the value was already
returned.
This change lets us simplify templates, as we don't have to check if
we're rendering the root object anymore: the configuration options are
chained in a way that prevent options that are only relevant to the root
object to be propagated further down to members.
Issue-658: mkdocstrings/mkdocstrings#658
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.
No description provided.