Skip to content

Force top-level of metadata to be an object #639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 24, 2020
Merged

Force top-level of metadata to be an object #639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/metadata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ is in the form of a
`JSON Schema <http://json-schema.org/>`_. A good to guide to creating JSON Schemas is at
`Understanding JSON Schema <https://json-schema.org/understanding-json-schema/>`_.

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