From 1bbcb89d68da0fcca495f36852165c60deb99247 Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 23 Oct 2024 15:16:22 +0200 Subject: [PATCH 1/2] Fix documentation on the environment element ingested by IngestReader into the metadata: the new attributes added in 1.5.0 were missing --- doc/src/ingest.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/src/ingest.rst b/doc/src/ingest.rst index 8a33b08..9360ee1 100644 --- 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: From 61f3444438e1b3366685a9e8aececa8d1b174563 Mon Sep 17 00:00:00 2001 From: Rolf Krahl Date: Wed, 23 Oct 2024 16:12:33 +0200 Subject: [PATCH 2/2] Update changelog --- CHANGES.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index d697983..5e18f09 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -2,6 +2,21 @@ Changelog ========= +.. _changes-1_5_1: + +1.5.1 (2024-10-25) +~~~~~~~~~~~~~~~~~~ + +Bug fixes and minor changes +--------------------------- + ++ `#165`_: Fix missing documentation on the environment injected by + :class:`icat.ingest.IngestReader` into the input as changed in + 1.5.0. + +.. _#165: https://github.com/icatproject/python-icat/pull/165 + + .. _changes-1_5_0: 1.5.0 (2024-10-11)