From f1496bc4639c7af19fd834cd9608247dcea3ff05 Mon Sep 17 00:00:00 2001
From: Alexander Schlemmer <alexander@mail-schlemmer.de>
Date: Fri, 27 Jan 2023 12:25:48 +0100
Subject: [PATCH] DOC: some clarifications of the cfood example
---
src/doc/tutorials/example.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/doc/tutorials/example.rst b/src/doc/tutorials/example.rst
index bd36ee8b..a1adee70 100644
--- a/src/doc/tutorials/example.rst
+++ b/src/doc/tutorials/example.rst
@@ -2,13 +2,13 @@ Example CFood
=============
Let's walk through an example cfood that makes use of a simple directory structure. We assume
-the structure to have the following form, starting from the file crawler root:
+the structure which is supposed to be crawled to have the following form:
.. code-block::
ExperimentalData/
- 2022_TestData/
+ 2022_ProjectA/
2022-02-17_TestDataset/
file1.dat
@@ -16,7 +16,7 @@ the structure to have the following form, starting from the file crawler root:
...
...
- 2023_AnotherDataFolder/
+ 2023_ProjectB/
...
...
@@ -32,7 +32,7 @@ Let's first clarify the terms we are using:
ExperimentalData/ <--- Category level (level 0)
- 2022_TestData/ <--- Project level (level 1)
+ 2022_ProjectA/ <--- Project level (level 1)
2022-02-17_TestDataset/ <--- Activity / Measurement level (level 2)
file1.dat <--- Files on level 3
@@ -40,7 +40,7 @@ Let's first clarify the terms we are using:
...
...
- 2023_AnotherDataFolder/ <--- Project level (level 1)
+ 2023_ProjectB/ <--- Project level (level 1)
...
...
--
GitLab