Skip to content

Commit 56038c7

Browse files
committed
DOCS: Orthography: add comment about orthography key
1 parent f4fbaf8 commit 56038c7

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

schemas/Orthography.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ properties:
1414
title: Abbreviation
1515
type: string
1616
$ref: https://schemas.digitallinguistics.io/MultiLangString.json
17-
description: 'An abbreviation for this Orthography.'
17+
description: An abbreviation for this Orthography.
1818

1919
direction:
2020
title: Text Direction
@@ -89,7 +89,8 @@ properties:
8989

9090
key:
9191
title: Key
92-
description: 'A unique human-readable identifier (typically a string) for this item, intended for use by software implementers as a dependable, stable way to refer to this language. In the DLx infrastruture, the orthography key is displayed next to any transcriptions in that orthography.'
92+
description: A unique human-readable identifier (typically a string) for this item, intended for use by software implementers as a dependable, stable way to refer to this language.
93+
$comment: In the DLx infrastruture, the orthography key is displayed next to any transcriptions in that orthography. (The key is used rather than the abbreviation, because using the abbreviation would require knowing which language to display the abbreviation in.)
9394

9495
link:
9596
title: Link

0 commit comments

Comments
 (0)