From df1d79226d011323dfdb108f8439ce9b590bd89b Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Mon, 7 Oct 2024 12:01:44 +0200 Subject: [PATCH] Add a paragraph to the module reference of icat.ingest explaining the new IngestReader class attributes --- doc/src/ingest.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/src/ingest.rst b/doc/src/ingest.rst index a12eca4..8a33b08 100644 --- 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