Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork48
Fine grain config#289
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
pawamoy wants to merge2 commits intomainChoose a base branch fromfine-grain-config
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Draft
Uh oh!
There was an error while loading.Please reload this page.
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 andlocal configuration. Instead of keeping track of dictionaries to mergethem accordingly, we now chain dataclasses together, using a special`UNSET` value to tell whether an option was set or not. Checking againstthis `UNSET` value lets the chained dataclass know whether it shouldtry 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 theright-most dataclass, where `some_option` is `UNSET`. Then it wouldcontinue on the left, and return `False` since it's not `UNSET`. Theleft-most dataclass would not be checked since the value was alreadyreturned.This change lets us simplify templates, as we don't have to check ifwe're rendering the root object anymore: the configuration options arechained in a way that prevent options that are only relevant to the rootobject to be propagated further down to members.Issue-658:mkdocstrings/mkdocstrings#658
Sign up for freeto 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.