Recommend that YAML keys be alphabetically sorted. #319
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 a recommendation that the keys in the YAML metadata block (in both "embedded" and "external" modes) SHOULD be sorted by case-sensitive alphabetical order. There is no particular reason for recommending alphabetical order over any other type of order, beyond the fact that sssom-py is already using alphabetical order (probably because that is seemingly the default behaviour of the PyYAML's 'safe_dump' method used by sssom-py). So we just take the order that is de facto in use in the wild and make it the officially recommended order.
4 tasks
|
Closing since the alternative proposition (#320) has been approved. (In the event someone objects to “spec order“ and makes a case for alphabetical order we can reopen this one.) |
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 PR adds a recommendation that the keys in the YAML metadata block (in both "embedded" and "external" modes) SHOULD be sorted by case-sensitive alphabetical order.
There is no particular reason for recommending alphabetical order over any other type of order, beyond the fact that
sssom-pyis already using alphabetical order (probably because that is seemingly the default behaviour of the PyYAML'ssafe_dumpmethod used bysssom-py). So we just take the order that is de facto in use in the wild and make it the officially recommended order.docs/have been added/updated if necessarymake testhas been run locally (no, documentation change only)