linting

Author: Remi-Gau

.github/workflows/check_md_links.yml

@@ -14,4 +14,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@master
-    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1

.pre-commit-config.yaml

@@ -12,28 +12,28 @@ repos:
       language: python
       additional_dependencies: [miss_hit_core]
 
-    - id: mh_style
-      name: mh_style
-      entry: mh_style
-      args: [--process-slx, --fix]
-      files: ^(.*\.(m|slx))$
-      language: python
-      additional_dependencies: [miss_hit_core]
+    # - id: mh_style
+    #   name: mh_style
+    #   entry: mh_style
+    #   args: [--process-slx, --fix]
+    #   files: ^(.*\.(m|slx))$
+    #   language: python
+    #   additional_dependencies: [miss_hit_core]
 
-    - id: mh_metric
-      name: mh_metric
-      entry: mh_metric
-      args: [--ci]
-      files: ^(.*\.(m|slx))$
-      language: python
-      additional_dependencies: [miss_hit_core]
+    # - id: mh_metric
+    #   name: mh_metric
+    #   entry: mh_metric
+    #   args: [--ci]
+    #   files: ^(.*\.(m|slx))$
+    #   language: python
+    #   additional_dependencies: [miss_hit_core]
 
-    - id: mh_lint
-      name: mh_lint
-      entry: mh_lint
-      files: ^(.*\.(m|slx))$
-      language: python
-      additional_dependencies: [miss_hit]
+    # - id: mh_lint
+    #   name: mh_lint
+    #   entry: mh_lint
+    #   files: ^(.*\.(m|slx))$
+    #   language: python
+    #   additional_dependencies: [miss_hit]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v2.0.0

.readthedocs.yml

@@ -23,4 +23,4 @@ formats:
 python:
   version: 3.7
   install:
-    - requirements: requirements.txt
+    - requirements: requirements.txt

.zenodo.json

@@ -26,4 +26,4 @@
   ],
   "license": "MIT license",
   "upload_type": "software"
-}
+}

demos/miss_hit.cfg

@@ -1,6 +1,7 @@
 # style guide (https://florianschanda.github.io/miss_hit/style_checker.html)
 line_length: 100
 regex_function_name: "CPP_[a-z]+(([A-Z]){1}[A-Za-z]+)*"
+regex_script_name: "CPP_[a-z]+(([A-Z]){1}[A-Za-z]+)*"
 copyright_entity: "Sam Schwarzkopf"
 copyright_entity: "Agah Karakuzu"
 copyright_entity: "CPP_PTB developers"
@@ -9,4 +10,4 @@ copyright_entity: "CPP_PTB developers"
 metric "cnest": limit 4
 metric "file_length": limit 500
 metric "cyc": limit 15
-metric "parameters": limit 5
+metric "parameters": limit 5

demos/video/CPP_playVideoFramesDemo.m

@@ -4,89 +4,82 @@
 
 % as it is, it presents two example videos in succession
 
-
 % add parent directory to matlab path (so we can access the CPP_PTB functions)
 addpath(fullfile(pwd, '..'));
 
 %% start with a clean slate
 clear;
 clc;
 
-
 %% initialize PTB % This can def be improved by using other CPP_PTB functions%
 
-    % Skip the PTB sync test
-    Screen('Preference', 'SkipSyncTests', 2);
+% Skip the PTB sync test
+Screen('Preference', 'SkipSyncTests', 2);
+
+% Get the screen numbers and draw to the external screen if avaliable
+cfg.screen.idx = max(Screen('Screens'));
 
-    % Get the screen numbers and draw to the external screen if avaliable
-    cfg.screen.idx = max(Screen('Screens'));
+% Set the PTB window background manually
+cfg.color.background = [127 127 127];
 
-    % Set the PTB window background manually
-    cfg.color.background = [127 127 127];
+% Get the screen numbers and draw to the external screen if avaliable
+cfg.screen.idx = max(Screen('Screens'));
 
-    % Get the screen numbers and draw to the external screen if avaliable
-    cfg.screen.idx = max(Screen('Screens'));
+% Open an on screen window
+[cfg.screen.win, cfg.screen.winRect] = Screen('OpenWindow', cfg.screen.idx, cfg.color.background);
 
-    % Open an on screen window
-    [cfg.screen.win, cfg.screen.winRect] = Screen('OpenWindow', cfg.screen.idx, cfg.color.background);
-    
-    
 %% Strcuture for video related info
 
-    % The name of your "video" and its images format
-    video.names = {'coffee','leaves'};
-    
-    % The number of frames of your video you want to present
-    % If left empty, all available frames are taken
-    video.frame.numbers = [];
-    % video.frame.numbers = 30;
-    % video.frame.numbers = [30,15];
+% The name of your "video" and its images format
+video.names = {'coffee', 'leaves'};
 
-    % The format fo the images
-    video.frame.format = '.jpeg'; % can be any img format compatible with the "imread" function
+% The number of frames of your video you want to present
+% If left empty, all available frames are taken
+video.frame.numbers = [];
+% video.frame.numbers = 30;
+% video.frame.numbers = [30,15];
 
-    % the folder where the images are (from the current folder)
-    video.stimuli.folder = 'stimuli/';
+% The format fo the images
+video.frame.format = '.jpeg'; % can be any img format compatible with the "imread" function
 
-    % The frame rate at which you want to present your video
-    video.frame.rate = 29.97;
+% the folder where the images are (from the current folder)
+video.stimuli.folder = 'stimuli/';
 
-    % Time bw videos in s
-    video.isi = 1;
+% The frame rate at which you want to present your video
+video.frame.rate = 29.97;
+
+% Time bw videos in s
+video.isi = 1;
 
-    
 %% present the videos in a loop
 
-    for trial = 1:length(video.names)
-        
+for trial = 1:length(video.names)
+
     % select name and folder where current video is
     video.name = video.names{trial};
-    video.path = fullfile(video.stimuli.folder,video.name);
-    
-    
+    video.path = fullfile(video.stimuli.folder, video.name);
+
     % how many frames are going to be presented
     if numel(video.frame.numbers) < 1
-        video.frame.number = size(dir([video.path,'/*',video.frame.format]),1);
-        
+        video.frame.number = size(dir([video.path, '/*', video.frame.format]), 1);
+
     elseif numel(video.frame.numbers) > 1
         video.frame.number = video.frame.numbers(trial);
-    
+
     else
         video.frame.number = video.frame.numbers;
     end
-        
-    
+
     % Read the images and create the stucture with their textures
     [video, cfg] = createFramesTextureStructure(video, cfg);
 
     % Play the video
     playVideoFrames(video, cfg);
-    
+
     % ISI (better would be to use Flip)
     WaitSecs(video.isi);
-    
-    end
 
+end
 
-    % The end
-    sca;
+% The end
+sca;

docs/Makefile

@@ -20,4 +20,4 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 doc:
-	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)"
+	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)"

docs/source/installation.rst

@@ -76,7 +76,7 @@ Add it as a submodule in the repo you are working on.
    :linenos:
 
    cd fullpath_to_directory_where_to_install
-   
+
    # use git to download the code
    git submodule add https://github.com/cpp-lln-lab/CPP_PTB.git
 

docs/source/set_up.rst

@@ -47,7 +47,7 @@ cfg.keyboard
                                           % (that of the experimenter)
     cfg.keyboard.responseBox = [];      % device index used by the participants
     cfg.keyboard.responseKey = {};      % list the keys that PTB should "listen" to when
-                                          % using KbQueue to collect responses ; 
+                                          % using KbQueue to collect responses ;
                                           % if empty PTB will listen to all key presses
     cfg.keyboard.escapeKey = 'ESCAPE';  % key to press to escape