Skip to content

CHANGES

Definition:

Version history of the dataset (describing changes, updates and corrections) MAY be provided in the form of a 'CHANGES' text file. (.txt or .md).

Properties:

Property Value Description
baseDir / Name of the directory under which the file object is expected to appear.
stem CHANGES Portion of the filename which excludes the extension.
arbitraryNesting False Indicator for whether a given file object is allowed to be nested within an arbitrary number of subdirectories.
extensions ['.md', '.txt'] Extension of current file including initial dot

If object not found:

Property Value
code MISSING_CHANGES_DOC
level warning
reason It is recommended to include a 'CHANGES.md' or 'CHANGES.txt' file in the base directory