Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add missing documentation on the environment ingested by IngestReader into the input #165

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Add missing documentation on the environment ingested by IngestReader into the input #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/src/ingest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down