edf2csv 0.5.95 → 0.5.97

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,44 @@
3
3
  Notable changes to edf2csv. Versions follow [semantic versioning](https://semver.org); while the
4
4
  major version is 0, a minor bump may contain breaking changes.
5
5
 
6
+ ## 0.5.97
7
+
8
+ ### Fixed: three pages said `--info` reads only the header, on files where it reads records
9
+
10
+ "`--info` reads only the header for plain EDF and continuous EDF+, so it returns in
11
+ milliseconds whatever the file's size." Getting-started said it, recipes said it twice.
12
+
13
+ Since 0.5.46 it reads up to sixteen records' annotation slots of a *continuous* EDF+ as well,
14
+ to find where the recording begins — which is why it raises `ANNOTATION_DECODE_FAILED` on
15
+ `lost-timekeeping.edf`, a continuous file, and prints `Timed from 0.500s` for
16
+ `fractional-start.edf`, another one. Both are behaviours the pages elsewhere describe and
17
+ recommend.
18
+
19
+ warnings-and-errors has had this right since 0.5.37 — "the first few records of a continuous
20
+ one to find where the recording begins" — and cli-reference points readers there for the
21
+ answer, so three pages contradicted the fourth about how much of a file a command touches.
22
+
23
+ All three say what it does now, and link to the page that sets out which warnings follow. The
24
+ test asserts the behaviour first and the prose second: if `--info` ever really did stop reading
25
+ records, the pages would be right and this test is what should fail.
26
+
27
+ ## 0.5.96
28
+
29
+ ### Fixed: api.md said `readAnnotations` returns three counts, then named four
30
+
31
+ 0.5.58 added `negativeDurations` to the list and left the number in front of it. That is the
32
+ mistake 0.5.62 fixed one page over — "This code covers three conditions" against a list of five
33
+ — on a sentence a reader checks against the list in the same breath.
34
+
35
+ The pronoun after it had slipped the same way: "That last one is why `duration` being `null` is
36
+ not by itself the same as the file giving no duration" was written when `unreadableDurations`
37
+ was last in the sentence, and by then it named `negativeDurations`, which is not what the
38
+ paragraph goes on to describe. It names the count now rather than pointing at a position.
39
+
40
+ The number is counted from `readAnnotations`'s own return type, so the page has to agree with
41
+ the function rather than with itself, and every count it returns has to be named — a number is
42
+ only useful with the list.
43
+
6
44
  ## 0.5.95
7
45
 
8
46
  ### Fixed: api.md's cheap timing recipe mistimes every record after a gap, and says the conversion uses it
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edf2csv",
3
- "version": "0.5.95",
3
+ "version": "0.5.97",
4
4
  "description": "Convert EDF, EDF+ and BDF biosignal recordings (European Data Format) to CSV from the command line. Local, streaming, and never resamples or alters units.",
5
5
  "keywords": [
6
6
  "edf",