Added additional information on the Sources requirements - #703
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Address the invalid non-prefixed mapping case and revise the skos:closeMatch wording.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Updates HED documentation with stricter annotation and source-validation requirements.
Changes:
- Defines annotation and SKOS mapping syntax.
- Adds
SCHEMA_ANNOTATION_INVALIDvalidation cases. - Clarifies source matching and updates the changelog.
File summaries
| File | Summary |
|---|---|
docs/source/Appendix_B.md |
Adds annotation validation cases. Moderate: non-prefixed mapping values are not reported as invalid. |
docs/source/Appendix_A.md |
Clarifies annotation and source requirements. Nit: skos:closeMatch wording overstates interchangeability. |
docs/source/03_HED_formats.md |
Links Sources rows to dc:source. |
CHANGELOG.md |
Records the specification changes. |
Review details
Suppressed comments (1)
docs/source/Appendix_A.md:370
- The description of
skos:closeMatchoverstates the SKOS relation:closeMatchmeans concepts may be used interchangeably in some information-retrieval applications, not in most applications. This wording could lead schema authors and consumers to treat a close match as a generally interchangeable equivalence.
The `annotation` attribute attaches a property from an external ontology or vocabulary to a HED schema element. The attribute was added in version `8.3.0`. For standard schemas with versions >= `8.5.0` and library schemas partnered with them (HED specification `4.0.0`), the value has the form `prefix:id value`: `prefix:id` names a row of the External annotations section ([A.1.8. External annotations](#a18-external-annotations)), whose `prefix` is a row of the Prefixes section ([A.1.7. Schema prefixes](#a17-schema-prefixes)), and `value` is that property's value. For example, `rdfs:comment Should have this tag in every event process.` attaches a comment, and `dc:source Wikipedia` cites a source ([A.1.6. Schema sources](#a16-schema-sources) says what a `dc:source` value must name). A link from a schema element to a term in an external ontology uses a SKOS mapping property whose value is the external term in prefix notation: `skos:exactMatch ncit:C25499` states that the element and NCI Thesaurus term C25499 denote the same concept, and `skos:closeMatch` that they are close enough to be used interchangeably in most applications. The prefix of such a term (`ncit:`) must be a row of the Prefixes section; the term itself is not checked. An element may carry several `annotation` attributes. A value that breaks these rules is a [SCHEMA_ANNOTATION_INVALID](./Appendix_B.md#schema_annotation_invalid) warning. Earlier schemas wrote a bare term such as `ncit:C25499`; files partnered with standard schemas before `8.5.0` keep that form, and tools do not check it.
- Files reviewed: 4/4 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
No description provided.