Merge pull request #163 from cpp-lln-lab/dev

[ENH] release 1.2.1

Author: Remi-Gau

.github/workflows/check_markdown.yml

@@ -7,11 +7,11 @@ on:
     branches:
       - master
   pull_request:
-    branches: '*'
+    branches: ['*']
 
 jobs:
   markdown-link-check:
     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

.github/workflows/check_md_links.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - master
   pull_request:
-    branches: '*'
+    branches: ['*']
 
 jobs:
   build:

.github/workflows/miss_hit.yml

@@ -1,11 +1,11 @@
-name: MOxUnit
+name: tests and coverage
 
 on:
   push:
     branches:
       - master
   pull_request:
-    branches: '*'
+    branches: ['*']
 
 jobs:
   build:
@@ -16,7 +16,7 @@ jobs:
         submodules: true
         fetch-depth: 1
     - name: MOxUnit Action
-      uses: joergbrech/moxunit-action@v1.1
+      uses: joergbrech/moxunit-action@v1.2.0
       with:
         tests: tests
         src: src

.github/workflows/moxunit.yml renamed to .github/workflows/run_tests.yml

@@ -0,0 +1,44 @@
+repos:
+
+-   repo: local
+
+    hooks:
+
+    - id: mh_version
+      name: mh_version
+      entry: mh_style
+      args: [-v]
+      verbose: true
+      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_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
+  hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files

.pre-commit-config.yaml

@@ -21,6 +21,6 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
+  version: "3.7"
   install:
-    - requirements: requirements.txt
+    - requirements: requirements.txt

.readthedocs.yml

@@ -16,6 +16,14 @@
       "affiliation": "Université Catholique de Louvain",
       "name": "Battal, Ceren",
       "orcid": "0000-0002-9844-7630"
+    },
+    {
+      "affiliation": "Université Catholique de Louvain",
+      "name": "Falagiarda, Federica"
+    },
+    {
+      "affiliation": "Université Catholique de Louvain",
+      "name": "Shahzad, Iqra"
     }
   ],
   "keywords": [
@@ -26,4 +34,4 @@
   ],
   "license": "MIT license",
   "upload_type": "software"
-}
+}

.remarkrc

@@ -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