Update documentation for layer dependencies declaration #16406
Merged
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
Users interested in writing their first configuration layer should be incentivized to use the configuration-layer/declare-layer-dependencies function instead of manually declaring a single layer.
smile13241324
approved these changes
May 20, 2024
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.
I think users interested in writing their first configuration layer should be incentivized to use the
configuration-layer/declare-layer-dependenciesfunction instead of manually declaring a single layer.As I was going through the
LAYERS.orgdocumentation I noticed most existing layers made use ofconfiguration-layer/declare-layer-dependenciesin theirlayers.elfile, instead of the recommendedconfiguration-layer/declare-layer.This seems to be consistent with the configuration-layer/declare-dependencies docstring as well as
this comment which suggests declaring layers right away should only be done in special cases by distribution layers.