chore: docs

DouglasNeuroInformatics · Sep 20, 2024 · 6571585 · 6571585
1 parent 353a0d5
commit 6571585
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 34 deletions.
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -54,14 +54,19 @@ Adding stimuli
 
 Stimuli are added to the data.csv found in the ``dist/`` directory as follows:
 
-..table:: Grid table
-
-| Stimulus Image Path | Difficulty Level | Correct Response | Language |
-|----------------------|------------------|------------------|----------|
-| path/to/img_of_a_dog.jpg | 1 | A dog | en |
-| path/to/img_of_a_cat.jpg | 2 | A cat | en |
-| path/to/img_of_a_dog.jpg | 1 | Un chien | fr |
-| path/to/img_of_a_cat.jpg | 2 | Un chat | fr |
+.. table:: Grid table
+
++---------------------------+------------------+-------------------+----------+
+| Stimulus Image Path       | Difficulty Level | Correct Response  | Language |
++===========================+==================+===================+==========+
+| path/to/img_of_a_dog.jpg  | 1                | A dog             | en       |
++---------------------------+------------------+-------------------+----------+
+| path/to/img_of_a_cat.jpg  | 2                | A cat             | en       |
++---------------------------+------------------+-------------------+----------+
+| path/to/img_of_a_dog.jpg  | 1                | Un chien          | fr       |
++---------------------------+------------------+-------------------+----------+
+| path/to/img_of_a_cat.jpg  | 2                | Un chat           | fr       |
++---------------------------+------------------+-------------------+----------+
 
 Currently there are nine directories with images corresponding to nine difficulty levels. 
 These are located in ``dist/level1 ... dist/level9`` if the ``dist`` was download. 
@@ -84,18 +89,27 @@ These settings are described below:
 - **initialDifficulty** <number>: the difficulty that the task will start with
 - **numberOfLevels** <number>: the number of levels that are available for the task
 
-..table:: Grid table
-
-| Setting | Value |
-|---------|--------|
-| totalNumberOfTrialsToRun | 5 |
-| advancementSchedule | 2 |
-| regressionSchedule | 0 |
-| language | en |
-| seed | 42 |
-| initialDifficulty | 1 |
-| numberOfLevels | 9 |
-| downloadOnFinish | False |
+.. table:: Grid table
+
++-------------------------+-------+
+| Setting                 | Value |
++=========================+=======+
+| totalNumberOfTrialsToRun| 5     |
++-------------------------+-------+
+| advancementSchedule     | 2     |
++-------------------------+-------+
+| regressionSchedule      | 0     |
++-------------------------+-------+
+| language                | en    |
++-------------------------+-------+
+| seed                    | 42    |
++-------------------------+-------+
+| initialDifficulty       | 1     |
++-------------------------+-------+
+| numberOfLevels          | 9     |
++-------------------------+-------+
+| downloadOnFinish        | False |
++-------------------------+-------+
 
 
 
diff --git a/docs/source/usageODC.rst b/docs/source/usageODC.rst
@@ -56,18 +56,25 @@ These settings are described below:
 - **numberOfLevels** <number>: the number of levels that are available for the task
 - **downloadOnFinish** <``true`` or ``false``>: If set to true will download a copy of the data as .csv file in addition to saving the data in ODC
 
-..table:: Grid table
-
-| Setting | Value |
-|---------|--------|
-| totalNumberOfTrialsToRun | 5 |
-| advancementSchedule | 2 |
-| regressionSchedule | 0 |
-| language | en |
-| seed | 42 |
-| initialDifficulty | 1 |
-| numberOfLevels | 9 |
-| downloadOnFinish | False |
-
-
+.. table:: Grid table
+
++-------------------------+-------+
+| Setting                 | Value |
++=========================+=======+
+| totalNumberOfTrialsToRun| 5     |
++-------------------------+-------+
+| advancementSchedule     | 2     |
++-------------------------+-------+
+| regressionSchedule      | 0     |
++-------------------------+-------+
+| language                | en    |
++-------------------------+-------+
+| seed                    | 42    |
++-------------------------+-------+
+| initialDifficulty       | 1     |
++-------------------------+-------+
+| numberOfLevels          | 9     |
++-------------------------+-------+
+| downloadOnFinish        | False |
++-------------------------+-------+