Add "---" to separate functions on lib files #969
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What was done?
A yaml separator was added between functions on the example .lib.yml files.
Why was this done?
I found that the playground's functions example explains how this can be done to isolate functions when the format conflicts with the rest of the file.
In the case of the .lib.yml files it's my understanding their only purpose is to centralize functions, it's true that a conflict won't always exist, yet I believe it would be a good practice to always isolate functions on this files, by doing this the format of .lib.yml files remains consistent (without sporadic separator here and there) making the file easier to read and in the case of actual conflicts developers who are used to follow this format should (in theory) not even encounter any issue.