add --- document separator to beginning of deprecated.yaml file
#852
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
add `---` document separator to beginning oy deprecated.yaml file
turbomam
changed the title
--- document separator to beginning oy deprecated.yaml file--- document separator to beginning of deprecated.yaml file
|
Do you want to go ahead and merge this in @turbomam? |
|
@sujaypatil96 yes, I don't see it as controversial, but I guess it would be get some review from @mslarae13 and or @lschriml |
|
add guidance about YAML formatting to whatever existing documentation we have |
turbomam
deleted the
851-add-document-separator-to-beginning-of-srcmixsschemadeprecatedyaml
branch
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.
LinkML provides a linkml-lint tool to check for schema content that isn't illegal but is strongly discouraged.
But even that doesn't check for standardized YAML content. Sticking with a standardized YAML format can help us detect unusual styles before they become LinkML errors.
@sujaypatil96 and I added a GitHub action that runs mixs.yaml though
yamllintin a previous PR.This PR is the fruition of
yamllint: it noticed that we are not starting mixs.yaml with the recommended YAML document separator (---) , so we are proposing to add it in this PR.The document separator is not required in a file that only contains a single document (which is the case mixs.yaml), but is an illustration of using a standardized format. Eventually we will be able to detect unusual styles with
yamllintand fix them with yamlfmt.The MIxS community can collectively decide which
yamllintandyamlfmtsuggested styles we want to accept as is, which we wish to fine tune, and which we wish to disregard.