From cf3fee8a86d8e00e8525c8c94e0224439dd29a9c Mon Sep 17 00:00:00 2001 From: Hagen Wierstorf Date: Tue, 6 Dec 2022 13:58:32 +0100 Subject: [PATCH] DOC: provide introduction to audformat.define --- docs/api-define.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/api-define.rst b/docs/api-define.rst index f074f42c..1a402709 100644 --- a/docs/api-define.rst +++ b/docs/api-define.rst @@ -3,6 +3,34 @@ audformat.define .. automodule:: audformat.define +The :mod:`audformat.define` module +provides definitions of string values +that are part of the +:ref:`audformat specifications ` +and should not be changed by a user, +namely those inside + +* :class:`audformat.define.DataType` +* :class:`audformat.define.IndexField` +* :class:`audformat.define.MediaType` +* :class:`audformat.define.RaterType` +* :class:`audformat.define.SplitType` +* :class:`audformat.define.TableStorageFormat` +* :class:`audformat.define.Usage` + +In addition, +it provides definitions of string values +commonly used inside a database, +like licenses or scheme labels. +Those are not part of the +:ref:`audformat specifications ` +and can be changed by a user, +namely those inside + +* :class:`audformat.define.IndexType` +* :class:`audformat.define.Gender` +* :class:`audformat.define.License` + DataType ---------