Skip to content

Commit

Permalink
Misc fixes.
Browse files Browse the repository at this point in the history
Clarify reference to `slot_name` in the description of the `property`
slot.

Fix incorrect reference to a SSSOM/TSV _writer_ (not _reader_) when we
state that unknown slots MUST NOT be written in SSSOM/TSV files.

Replace "catenate" by "concatenate". My understanding is that the two
terms are actually equivalent, but "concatenate" is for some reason more
widely used at least in computer science.
  • Loading branch information
gouttegd committed Aug 4, 2024
1 parent 3074df6 commit 1e06548
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/docs/spec-formats-tsv.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Implementations that support condensation MUST also support propagation.
If an implementation does not support [non-standard slots](spec-model.md#non-standard-slots), then:

* a SSSOM/TSV reader MUST discard any unknown top-level YAML key in the metadata block, and any unknown TSV column in the TSV section;
* a SSSOM/TSV reader MUST NOT write any unknown top-level YAML key in the metadata block, or any unknown TSV column in the TSV section.
* a SSSOM/TSV writer MUST NOT write any unknown top-level YAML key in the metadata block, or any unknown TSV column in the TSV section.

### Support for defined extensions

Expand Down
2 changes: 1 addition & 1 deletion src/docs/spec-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ A definition MUST have at least a `slot_name`. The name MUST be a XML “non-col

To avoid any conflicy with a future version of the SSSOM specification (which could introduce new standard slot names), implementations are strongly encouraged to craft extension slot names that start with the `ext_` prefix. No new standard slot with a name starting with `ext_` will ever be introduced in any future version of the standard. (This is an advice for SSSOM producers only; SSSOM consumers MUST NOT reject an extension slot solely on the basis that its name does not start with `ext`.)

A definition SHOULD have a `property`. If it does not, implementations MUST automatically construct a default property by catenating the prefix `http://sssom.invalid/` with the name of the extension.
A definition SHOULD have a `property`. If it does not, implementations MUST automatically construct a default property by concatenating the prefix `http://sssom.invalid/` with the name of the extension.

The slot name and the property MUST be unique to each definition. No two definitions can share the same name and/or the same property.

Expand Down
2 changes: 1 addition & 1 deletion src/sssom_schema/schema/sssom_schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,7 @@ classes:
property:
description: The property associated with the extension slot. It is
intended to provide a non-ambiguous meaning to the slot (contrary
to the name, which for brevity reasons may be ambiguous).
to the slot_name, which for brevity reasons may be ambiguous).
range: uriorcurie
type_hint:
description: Expected type of the values of the extension slot.
Expand Down

0 comments on commit 1e06548

Please sign in to comment.