Skip to content

Commit 415ab8a

Browse files
committed
capitalization
1 parent d64e1b4 commit 415ab8a

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/decision_record.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -414,15 +414,15 @@ Adding prefixes will complicate things and does not add benefits. Prefixes may b
414414
- <https://github.com/ga4gh/refget/issues/37>
415415

416416

417-
## 2023-06-28 - SeqCol JSON schema defines reserved attributes without additional namespacing
417+
## 2023-06-28 - Seqcol JSON schema defines reserved attributes without additional namespacing
418418

419419
### Decision
420420

421421
One potential issue may arise if a custom implementation uses an attribute that a future version of seqcol adds to the schema, and if these attributes are defined differently. This will create a name clash and the custom implementation wouldn't be compatible with the future seqcol schema. It would be nice to prevent such future clashes, which would require ensuring that future seqcol attributes mean the same thing across collections so they are compatible. One way to solve this would be to define an namespace reserved by the specification, so that custom attributes look different and will therefore guarantee that custom attribute never clashes with seqcol attributes, thereby ensuring that custom implementations will be compatible with any future schema updates.
422422

423423
Despite the potential issue for custom attribute clashes, we decided:
424424

425-
1. We will not use any additional namespacing. Instead, the SeqCol schema declares and defines the specific attributes of a sequence collection. We will "claim" any reserved keywords in the secqol schema we publish, not by defining a style or namespace of reserved keywords.
425+
1. We will not use any additional namespacing. Instead, the seqcol schema declares and defines the specific attributes of a sequence collection. We will "claim" any reserved keywords in the secqol schema we publish, not by defining a style or namespace of reserved keywords.
426426

427427
2. We will try to add to this many things that we forsee as possible attributes that could be defined in a seqcol. Thus, we will provide an official set of definitions that should prevent many possible future clashes.
428428

docs/seqcols/compare_collections.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can also `POST` a local collection to `/comparison/:digest1` to compare it t
1212
The comparison function gives information-rich feedback about the two collections, but it can take some thought to interpret.
1313
Here are some examples.
1414

15-
The best way is to use the Refget [SeqCol Comparison Interpretation Module (SCIM)](https://refget.databio.org/scim/).
15+
The best way is to use the Refget [Seqcol Comparison Interpretation Module (SCIM)](https://refget.databio.org/scim/).
1616
You paste in the JSON output of a comparison, and it provides an interpretation for you.
1717

1818
## Interpretation details

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav:
88
- Sequences: sequences/README.md
99
- Sequence Collections: seqcols/README.md
1010
- Detailed how-to guides:
11-
- Compute a digest given a SeqCol: seqcols/digest_from_collection.md
11+
- Compute a digest given a seqcol: seqcols/digest_from_collection.md
1212
- Compare two sequence collections: seqcols/compare_collections.md
1313
- Implementations:
1414
- Python: implementation_python.md

0 commit comments

Comments
 (0)