From aa63008257011c86f120a6498abaa9c08e04ce0d Mon Sep 17 00:00:00 2001 From: Stephan Druskat Date: Wed, 20 Dec 2017 21:41:29 +0100 Subject: [PATCH] Add a note about the arbitrary order of keys in the CFF file - cf. https://twitter.com/Britpunk80/status/943519796339052544 --- 1.0.3/specifications.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/1.0.3/specifications.md b/1.0.3/specifications.md index 823f092b..67208284 100644 --- a/1.0.3/specifications.md +++ b/1.0.3/specifications.md @@ -202,8 +202,11 @@ general. These include: ## File structure CFF `CITATION` files represent YAML 1.2 dictionaries ("maps") with -the following keys listed in the table below. These primary keys -are used to specify +the keys listed in the table below. Note that the order of the keys is arbitrary, +and that most YAML [linter](https://en.wikipedia.org/wiki/Lint_(software))s +will re-order the keys alphabetically. + +The primary keys are used to specify - the version of CFF in use (`cff-version`); - a message which should be conveyed to the user of the software,