Recommend that YAML keys be sorted by "spec order". #320
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
1) the keys in the YAML metadata block (in both "embedded" and
"external" modes) SHOULD be sorted in the same order as the
corresponding slots are listed in the definition of the MappingSet
class in the SSSOM model;
2) the keys in the 'curie_map' dictionary (i.e. the prefix names) SHOULD
be sorted by alphabetical order.
matentzn
approved these changes
Sep 20, 2023
|
This can be merged on Friday 22nd by anyone who sees this without permission! I just leave it Open in case there are objections that I don't know about. |
4 tasks
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 in the same order as the corresponding slots are listed in the definition of the MappingSet class in the SSSOM model;
the keys in the
curie_mapdictionary (i.e. the prefix names) SHOULD be sorted by alphabetical order.This is an alternative PR to #319 (which proposed to sort the YAML metadata block by alphabetical order). “Spec order“ is not the current behaviour of
sssom-py, but is preferred at least by @matentzn.Of note, since
curie_mapis currently not part of the model (and therefore not listed in the definition ofMappingSet), the position of thecurie_mapkey would be unspecified under the proposed recommendation. For what it’s worth, SSSOM-Java puts it at the top of the metadata block, before any other slot.docs/have been added/updated if necessarymake testhas been run locally (no, irrelevant)