Merge branch 'develop' into documentation

.github/workflows/binder.yml

@@ -2,7 +2,7 @@ name: binder
 on:
   push:
     branches:
-      - develop
+      - master
 
 jobs:
   Create-MyBinderOrg-Cache:

.github/workflows/flake8.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up Python environment
         uses: actions/setup-python@v1
         with:
-          python-version: "3.8"
+          python-version: "3.10"
       - name: flake8 Lint
         uses: py-actions/flake8@v1
         with:

pyerrors/input/sfcf.py

@@ -11,11 +11,22 @@ def read_sfcf(path, prefix, name, quarks='.*', corr_type='bi', noffset=0, wf=0,
 
     Parameters
     ----------
+    path : str
+        Path to the sfcf files.
+    prefix : str
+        Prefix of the sfcf files.
+    name : str
+        Name of the correlation function to read.
     quarks : str
         Label of the quarks used in the sfcf input file. e.g. "quark quark"
         for version 0.0 this does NOT need to be given with the typical " - "
         that is present in the output file,
         this is done automatically for this version
+    corr_type : str
+        Type of correlation function to read. Can be
+        - 'bi' for boundary-inner
+        - 'bb' for boundary-boundary
+        - 'bib' for boundary-inner-boundary
     noffset : int
         Offset of the source (only relevant when wavefunctions are used)
     wf : int
@@ -26,9 +37,6 @@ def read_sfcf(path, prefix, name, quarks='.*', corr_type='bi', noffset=0, wf=0,
     im : bool
         if True, read imaginary instead of real part
         of the correlation function.
-    corr_type : str
-        change between bi (boundary - inner) (default) bib (boundary - inner - boundary) and bb (boundary - boundary)
-        correlator types
     names : list
         Alternative labeling for replicas/ensembles.
         Has to have the appropriate length