Fix examples of SSSOM/TSV files. #362
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
gouttegd
force-pushed
the
fix-tsv-examples
branch
from
2a6c8c4 to
b8e6cb9
Compare
The examples provided in the SSSOM/TSV section of the "overview" document are full of errors and would fail the most basic validation by our own tools: - use of "Lexical" instead of "semapv:LexicalMatching" in the mapping_justification field (probably a remnant of the time prior to the adoption of the SEMAPV vocabulary); - bogus IRI prefix for the SKOS namespace (missing terminal '#'); - use of a full-length identifier (instead of a CURIE) for `creator_id`. This commit fixes those errors. In addition, it also ensures that the fields are listed in the *recommended order*. It's not critical but if we take the time to recommend that fields be sorted in a given order, the least we can do is to follow our own advice in our examples. While we are at it, we also add a small note about the requirement for using CURIEs in the SSSOM/TSV format, since that requirement currently does not appear anywhere but is already enforced by `sssom validate`.
gouttegd
force-pushed
the
fix-tsv-examples
branch
from
b8e6cb9 to
bf95682
Compare
1 task
4 tasks
joeflack4
reviewed
Apr 18, 2024
joeflack4
reviewed
Apr 19, 2024
|
Approve; Everything LGTM. |
joeflack4
approved these changes
Apr 20, 2024
ehartley
reviewed
Apr 20, 2024
ehartley
reviewed
Apr 20, 2024
The SKOS namespace is built-in, so canonically formatted files should not include it.
ehartley
reviewed
Apr 20, 2024
ehartley
reviewed
Apr 20, 2024
Make sure that embedded SSSOM/TSV examples use tabs in the source document -- even if they are all converted to spaces in the resulting HTML code.
ehartley
approved these changes
Apr 20, 2024
matentzn
approved these changes
Apr 21, 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.
The examples provided in the SSSOM/TSV section of the "overview" document are full of errors and would fail the most basic validation by our own tools:
Lexicalinstead ofsemapv:LexicalMatchingin themapping_justificationfield (probably a remnant of the time prior to the adoption of the SEMAPV vocabulary);#);creator_id.This PR fixes those errors. In addition, it also ensures that the fields are listed in the recommended order. It’s not critical but if we take the time to recommend that fields be sorted in a given order, the least we can do is to follow our own advice in our examples.
While we are at it, we also add a small note about the requirement for using CURIEs in the SSSOM/TSV format, since that requirement currently does not appear anywhere but is already enforced by
sssom validate.This is a band-aid until the docs are completely overhauled as part of #330.
docs/have been added/updated if necessary[ ]Not applicablemake testhas been run locally[ ] tests have been added/updated (if applicable)Not applicable[ ] CHANGELOG.md has been updated.Not applicable