From 3d5b47004bc57bdab33e95e47c035ac68b8b8543 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Sun, 23 May 2021 15:03:48 +0100 Subject: [PATCH] docs: Clarify zipfile contents Signed-off-by: Ian Jackson --- docs/bundles.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/bundles.rst b/docs/bundles.rst index 9d37173b..67a632f2 100644 --- a/docs/bundles.rst +++ b/docs/bundles.rst @@ -37,17 +37,18 @@ Bundles are zipfiles. They can contain: * ``library/LIB.toml``: Description of a piece shape library, for a library named ``LIB``. See :doc:`shapelibs`. -These files are all in TOML format. TOML ia an INI-file-like format -designed for human editing and flexibility. See the `TOML -documentation `_ for information about the syntax. +These ``.toml`` files are all in TOML format. TOML ia an +INI-file-like format designed for human editing and flexibility. See +the `TOML documentation `_ for information about +the syntax. The TOML specification has confusing terminology. In this manual we use "dictionary" (or "dict") for a mapping from (string) keys to values (what TOML calls a "table"). "Array" is an array or list of (more or less similar) values. -Any other files which might be present in the zipfile are ignored. -(Future versions of Otter might define a meaning for them.) +Any unrecognised files which might be present in the zipfile are +ignored. (Future versions of Otter might define a meaning for them.) Character set and case-sensitivity `````````````````````````````````` -- 2.30.2