Clarify config.get docstring #35492
Merged
Clarify config.get docstring #35492
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
This commit adds clarification that Salt's built-in config options cannot be overriden by config.get.
| :ref:`here <configuration-salt-minion>`) will *always* be defined in | ||
| the Minion configuration and thus *cannot be overridden by grains or | ||
| pillar data*. However, additional (user-defined) configuration options | ||
| (as in the above example) will not by in the Minion configuration by |
There was a problem hiding this comment.
Yep, good catch. Pushed a fix just now.
cachedout
added
the
Pending-Discussion
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.
This pull request adds clarification that Salt's built-in config options cannot be overriden by
config.get. It also reminds the user thatpillar_optsmust be set toTruein order for this function to return values from the master configuration file.