Apply suggestions from code review

Thanks Marco

Co-authored-by: marcobarilari <[email protected]>

Author: Remi-Gau

README.md

@@ -83,7 +83,7 @@ git pull origin master
 
 To work with a specific version, create a branch at a specific version tag number
 ```bash
-# creating and checking out a branch that will be calle version1 at the version tag v0.0.1
+# creating and checking out a branch that will be called version1 at the version tag v1.0.0
 git checkout -b version1 v1.0.0
 ```
 

docs/00_index.md

@@ -1,7 +1,7 @@
 # CPP_PTB documentation
 
 <!-- vscode-markdown-toc -->
-* 1. [the CFG gtructure](#theCFGgtructure)
+* 1. [the CFG structure](#theCFGstructure)
 * 2. [Setting up keyboards](#Settingupkeyboards)
 * 3. [functions descriptions](#functionsdescriptions)
 * 4. [Annexes](#Annexes)
@@ -14,7 +14,7 @@
 	/vscode-markdown-toc-config -->
 <!-- /vscode-markdown-toc -->
 
-##  1. <a name='theCFGgtructure'></a>the CFG gtructure
+##  1. <a name='theCFGstructure'></a>the CFG structure
 
 The `cfg` structure is where most of the information about your experiment will be defined.
 
@@ -48,12 +48,12 @@ cfg.debug.smallWin = true; % open a small window and not a full screen window ;
 % cfg.text
 cfg.text.font = 'Courier New';
 cfg.text.size = 18;
-cfg.text.style = 1; ???
+cfg.text.style = 1; % bold
 
 
 %% -------------------------------------------------------------------------- %%
 % cfg.color
-cfg.color.background % [r g b] each in 0-255
+cfg.color.background = [0 0 0]; % [r g b] each in 0-255
 
 
 %% -------------------------------------------------------------------------- %%
@@ -95,7 +95,7 @@ cfg.aperture.type = 'none'; % 'bar', 'wedge', 'ring', 'circle'
 % cfg.audio
 cfg.audio.do = false; % set to true if you are going to play some sounds
 cfg.audio.pahandle
-cfg.audio.devIdx = [ ];
+cfg.audio.devIdx = [];
 cfg.audio.playbackMode = 1;
 cfg.audio.requestedLatency = 3;
 cfg.audio.fs 44800; % sampling frequency 
@@ -184,4 +184,4 @@ It is composed of two parts:
  - the actual sandbox where to set your dynamic variables (the stimulation
    parameters) and the 'playground' where to develop the stimulation code
 
- When you are happy with it, ideally you will move the vars in `setParameters.m` and the stimulation code in a separate function in `my-experiment-folder/subfun`. The code style and variable names are the same used in `cpp-lln-lab/CPP_PTB` github repo, therefore it should be easy to move everything in your experiment scripts (see the template that is annexed in `cpp-lln-lab/CPP_PTB`).
+ When you are happy with it, ideally you will move the vars in `setParameters.m` and the stimulation code in a separate function in `my-experiment-folder/subfun`. The code style and variable names are the same used in `cpp-lln-lab/CPP_PTB` github repo, therefore it should be easy to move everything in your experiment scripts (see the template that is annexed in `cpp-lln-lab/CPP_PTB`).

docs/10_functions_description.md

@@ -154,10 +154,10 @@ where do you want to start buffering the responses).
     -   It only reports presses on the keys of interest mentioned at initialization.
     -   It **can** also check for presses on the escape key and abort if the escape 
 key is part of the keys of interest.
--   flush: Empties the buffer of key presses in case you want to discard any 
+-   flush: empties the buffer of key presses in case you want to discard any 
 previous key presses.
--   stop: Stops buffering key presses. You can still restart by calling "start" again.
--   release: Closes the buffer for good.
+-   stop: stops buffering key presses. You can still restart by calling "start" again.
+-   release: closes the buffer for good.
 
 ###  2.3. <a name='pressSpaceForme'></a>pressSpaceForme
 
@@ -200,4 +200,4 @@ they are not in consecutive positions.
 
 Given `baseConditionVector`, a vector of conditions (coded as numbers), this will 
 create a longer vector made of `nbRepeats` of this base vector and make sure that 
-a given condition is not repeated one after the other.
+a given condition is not repeated one after the other.