Skip to content

Commit 42715a8

Browse files
authored
Merge pull request #639 from benjeffery/metadata-top-level-object
Force top-level of metadata to be an object
2 parents c31e974 + 833a9e4 commit 42715a8

File tree

4 files changed

+251
-140
lines changed

4 files changed

+251
-140
lines changed

docs/metadata.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,10 @@ is in the form of a
1919
`JSON Schema <http://json-schema.org/>`_. A good to guide to creating JSON Schemas is at
2020
`Understanding JSON Schema <https://json-schema.org/understanding-json-schema/>`_.
2121

22-
In the most common case where the metadata schema specifies an object with properties,
22+
The metadata schema must specify an object with properties,
2323
the keys and types of those properties are specified along with optional
24-
long-form names, descriptions
25-
and validations such as min/max or regex matching for strings. See
26-
:ref:`sec_metadata_example` below. Names and descriptions can assist
24+
long-form names, descriptions and validations such as min/max or regex matching for
25+
strings. See :ref:`sec_metadata_example` below. Names and descriptions can assist
2726
downstream users in understanding and using the metadata. It is best practise to
2827
populate these fields if your files will be used by any third-party, or if you wish to
2928
remember what they were some time after making the file!

0 commit comments

Comments
 (0)