Skip to content

Commit aa63008

Browse files
committed
Add a note about the arbitrary order of keys in the CFF file
- cf. https://twitter.com/Britpunk80/status/943519796339052544
1 parent cb60d27 commit aa63008

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

1.0.3/specifications.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,11 @@ general. These include:
202202
## File structure
203203

204204
CFF `CITATION` files represent YAML 1.2 dictionaries ("maps") with
205-
the following keys listed in the table below. These primary keys
206-
are used to specify
205+
the keys listed in the table below. Note that the order of the keys is arbitrary,
206+
and that most YAML [linter](https://en.wikipedia.org/wiki/Lint_(software))s
207+
will re-order the keys alphabetically.
208+
209+
The primary keys are used to specify
207210

208211
- the version of CFF in use (`cff-version`);
209212
- a message which should be conveyed to the user of the software,

0 commit comments

Comments
 (0)