Conversation
meta-cla
Bot
added
the
CLA Signed
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Hydra’s “Selecting multiple configs from a Config Group” documentation and the linked examples/patterns/multi-select example to better focus on multi-select behavior within a single config group, and to correct/clarify override and deletion syntax discussed in #2695.
Changes:
- Clarifies how nested-list defaults relate to explicit defaults entries, and fixes the delete-path example in the docs.
- Simplifies the example by removing the extra
apache_httpsserver option and switching the example root config to a directserver/apacheinclude. - Aligns the example configuration syntax with what the docs describe.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| website/docs/patterns/select_multiple_configs_from_config_group.md | Clarifies composition semantics for nested lists and fixes the CLI delete-path example. |
| examples/patterns/multi-select/conf/server/apache_https.yaml | Removes the extra server option from the example configuration set. |
| examples/patterns/multi-select/conf/config.yaml | Switches the example defaults entry to a direct server/apache include. |
Comment on lines
1
to
+2
| defaults: | ||
| - server: apache | ||
| - server/apache |
Comment on lines
+149
to
+150
| A nested list in the Defaults List is interpreted as a list of non-overridable | ||
| configs. The following two forms compose the same output: |
| ### Implementation considerations | ||
|
|
||
| A nested list in the Defaults List is interpreted as a list of non-overridable configs: | ||
| A nested list in the Defaults List is interpreted as a list of non-overridable |
| ### Implementation considerations | ||
|
|
||
| A nested list in the Defaults List is interpreted as a list of non-overridable configs: | ||
| The following two forms compose the same output: |
Comment on lines
+132
to
+136
| Use the nested list form when you want to override the group later with | ||
| `server/site=[...]`. | ||
|
|
||
| To delete one of these non-overridable entries from the command line, use the | ||
| exact config path, for example `~site/fb`. | ||
| exact config path, for example `~server/site/fb`. |
Reduce the multi-select example to focus on selecting multiple configs from one config group. Remove the extra apache_https server option and use a direct server/apache include in the example config. Clarify that the nested list form composes like expanded config entries while preserving group override syntax, and fix the delete example path. Closes #2695.
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
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.
Reduce the multi-select example to focus on selecting multiple configs from one config group. Remove the extra apache_https server option and use a direct server/apache include in the example config.
Clarify that the nested list form composes like expanded config entries while preserving group override syntax, and fix the delete example path.
Closes #2695.