Add a paragraph to the module reference of icat.ingest explaining the

new IngestReader class attributes
icatproject · Oct 7, 2024 · df1d792 · df1d792
1 parent e536a5e
commit df1d792
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/src/ingest.rst b/doc/src/ingest.rst
@@ -23,6 +23,14 @@ format of the input files may be customized to some extent by
 providing custom versions of XSD and XSLT files, see
 :ref:`ingest-customize` below.
 
+Some attributes and relations of the ``Dataset`` objects are
+prescribed during the transformation into ICAT data file format,
+namely the ``complete`` attribute and the name of the ``DatasetType``
+to relate them to.  The prescribed values are set in class attributes
+:attr:`~icat.ingest.IngestReader.Dataset_complete` and
+:attr:`~icat.ingest.IngestReader.DatasetType_name` respectively.  They
+may be customized by overriding these class attributes.
+
 The ``Dataset`` objects in the input will not be created by
 :class:`~icat.ingest.IngestReader`, because it is assumed that a
 separate workflow in the caller will copy the content of datafiles to