From af88bb2260fcf93afccd5bf17b60dbb50516d9f5 Mon Sep 17 00:00:00 2001 From: fspreck <f.spreckelsen@indiscale.com> Date: Fri, 16 Feb 2024 16:51:23 +0100 Subject: [PATCH] FIX: Typos --- src/doc/converters.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/doc/converters.rst b/src/doc/converters.rst index de4e1115..2bbc67dc 100644 --- a/src/doc/converters.rst +++ b/src/doc/converters.rst @@ -235,7 +235,7 @@ HDF5 Converters For treating `HDF5 Files <https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html>`_, there are in total -four indivdual converters corresponding to the internal structure of HDF5 files: +four individual converters corresponding to the internal structure of HDF5 files: the :ref:`H5FileConverter` which opens the file itself and creates further structure elements from HDF5 groups, datasets, and included multi-dimensional arrays that are in turn treated by the :ref:`H5GroupConverter`, the @@ -260,7 +260,8 @@ metadata and their internal path within the HDF5 file. Users can thus query for datasets and their arrays according to their metadata within LinkAhead and then use the internal path information to access the dataset within the file directly. The type of this record and the property for storing the internal path -need to be reflected in the datamodel. Using the default names, you would need a datamodel like +need to be reflected in the datamodel. Using the default names, you would need a +datamodel like .. code-block:: yaml @@ -272,7 +273,7 @@ need to be reflected in the datamodel. Using the default names, you would need although the names of both property and record type can be configured within the cfood definition. -A simple example of a cfood definiton for HDF5 files can be found in the `unit +A simple example of a cfood definition for HDF5 files can be found in the `unit tests <https://gitlab.com/linkahead/linkahead-crawler/-/blob/main/unittests/h5_cfood.yml?ref_type=heads>`_ and shows how the individual converters are used in order to crawl a `simple @@ -286,7 +287,7 @@ H5FileConverter This is an extension of the :py:class:`~caoscrawler.converters.SimpleFileConverter` class. It opens the HDF5 -file and creates children for any contained group or dataset. Additionaly, the +file and creates children for any contained group or dataset. Additionally, the root-level attributes of the HDF5 file are accessible as children. H5GroupConverter -- GitLab