Fix documentation on the environment element ingested by IngestReader

into the metadata: the new attributes added in 1.5.0 were missing
icatproject · Oct 23, 2024 · 1bbcb89 · 1bbcb89
1 parent 647b465
commit 1bbcb89
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc/src/ingest.rst b/doc/src/ingest.rst
@@ -91,12 +91,21 @@ following attributes:
     :attr:`icat.client.Client.apiversion` attribute of the `client`
     object being used by this :class:`~icat.ingest.IngestReader`.
 
+  `dataset_complete`
+    The value of :attr:`~icat.ingest.IngestReader.Dataset_complete`.
+
+  `datasettype_name`
+    The value of :attr:`~icat.ingest.IngestReader.DatasetType_name`.
+
 More attributes may be added in future versions.  This
 ``_environment`` element may be used by the XSLT in order to adapt the
 result of the transformation to the environment, in particular to
 adapt the output to the ICAT schema version it is supposed to conform
 to.
 
+.. versionchanged:: 1.5.0
+   add attributes `dataset_complete` and `datasettype_name`.
+
 
 .. _ingest-example: