Update docs

open-cogsci · Oct 4, 2023 · 40ae932 · 40ae932
1 parent 6d8f76a
commit 40ae932
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/doc-pelican/build-api.py b/doc-pelican/build-api.py
@@ -6,7 +6,7 @@
 import yamldoc
 import imp
 
-ROOT = '/home/sebastiaan/git/python-datamatrix/'
+ROOT = '/home/sebastiaan/git/datamatrix/'
 TARGET = 'include/api/'
 sys.path.insert(0, ROOT)
 

diff --git a/doc-pelican/include/api/functional.md b/doc-pelican/include/api/functional.md
@@ -295,6 +295,9 @@ See also:
 
 *Version note:* New in 1.0.0.
 
+*Version note:* As of 1.0.4, if one of the processes crashes, and error
+is shown with the Exception, but the main process doesn't crash.
+
 __Example:__
 
 ```python

diff --git a/doc-pelican/include/api/multidimensional.md b/doc-pelican/include/api/multidimensional.md
@@ -131,7 +131,7 @@ An int column with the number of `NAN` values in each cell.
 
 <div class="FunctionDoc YAMLDoc" id="reduce" markdown="1">
 
-## function __reduce__\(col, operation=<function nanmean at 0x7f6ffa02b400>\)
+## function __reduce__\(col, operation=<function nanmean at 0x7f31341e1090>\)
 
 Transforms multidimensional values to single values by applying an
 operation (typically a mean) to each multidimensional value.
@@ -163,7 +163,7 @@ __Arguments:__
 __Keywords:__
 
 - `operation` -- The operation function to use for the reduction. This function should accept `col` as first argument, and `axis=1` as keyword argument.
-	- Default: <function nanmean at 0x7f6ffa02b400>
+	- Default: <function nanmean at 0x7f31341e1090>
 
 __Returns:__
 

diff --git a/doc-pelican/include/api/series.md b/doc-pelican/include/api/series.md
@@ -87,6 +87,11 @@ introduced, wich can be specified through the `mode` keyword. The
 advanced algorithm is recommended for new analyses, and will be made
 the default in future releases.
 
+*Version note:* As of 1.0.5 the advanced algorithm has been updated
+with a [bugfix](https://github.com/open-cogsci/datamatrix/pull/18) and
+the end of a blink is defined as the moment where the velocity drops
+to 1% of the velocity standard deviation, as opposed to 0.
+
 __Source:__
 
 - Mathot, S., & Vilotijević, A. (2022). Methods in cognitive 
@@ -176,7 +181,7 @@ A new series.
 
 <div class="FunctionDoc YAMLDoc" id="downsample" markdown="1">
 
-## function __downsample__\(series, by, fnc=<function nanmean at 0x7f6ffa02b400>\)
+## function __downsample__\(series, by, fnc=<function nanmean at 0x7f31341e1090>\)
 
 Downsamples a series by a factor, so that it becomes 'by' times
 shorter. The depth of the downsampled series is the highest multiple of
@@ -221,7 +226,7 @@ __Keywords:__
 
 - `fnc` -- The function to average the samples that are combined into 1 value. Typically an average or a median.
 	- Type: callable
-	- Default: <function nanmean at 0x7f6ffa02b400>
+	- Default: <function nanmean at 0x7f31341e1090>
 
 __Returns:__