edf2csv 0.5.96 → 0.5.98

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 +43 -0
  2. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,49 @@
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.98
7
+
8
+ ### Fixed: "what --info can and can't tell you" was wrong in both directions
9
+
10
+ cli-reference points readers at that section for the answer, which makes being wrong there
11
+ worse than being silent. It was wrong twice.
12
+
13
+ It said `--info` "also raises `ANNOTATION_DECODE_FAILED`", unqualified. It raises it for what
14
+ it read, and on a continuous file that is sixteen records — so `two-annotation-channels.edf`
15
+ warns about three unreadable events when converted and says nothing at all under `--info`. Its
16
+ byte-identical discontinuous twin warns either way, because there the whole channel is read.
17
+
18
+ And its list of what `--info` cannot raise — `NO_ANNOTATIONS`, `STALE_OUTPUT`, the EDF+C
19
+ contradiction — left out the `NO_SAMPLES` that reports a signal file *not written*.
20
+ `annotations-only.edf` raises it on conversion and not under `--info`. The per-channel
21
+ `NO_SAMPLES`, about a channel carrying no samples, comes from the header and is raised, so the
22
+ code alone does not settle it and the page now says which form it means.
23
+
24
+ Held to it by a sweep rather than by review: every fixture is described and converted, and any
25
+ code the conversion raises that `--info` does not has to be one the page names. That is how the
26
+ two missing ones were found, and it is what would find the next.
27
+
28
+ ## 0.5.97
29
+
30
+ ### Fixed: three pages said `--info` reads only the header, on files where it reads records
31
+
32
+ "`--info` reads only the header for plain EDF and continuous EDF+, so it returns in
33
+ milliseconds whatever the file's size." Getting-started said it, recipes said it twice.
34
+
35
+ Since 0.5.46 it reads up to sixteen records' annotation slots of a *continuous* EDF+ as well,
36
+ to find where the recording begins — which is why it raises `ANNOTATION_DECODE_FAILED` on
37
+ `lost-timekeeping.edf`, a continuous file, and prints `Timed from 0.500s` for
38
+ `fractional-start.edf`, another one. Both are behaviours the pages elsewhere describe and
39
+ recommend.
40
+
41
+ warnings-and-errors has had this right since 0.5.37 — "the first few records of a continuous
42
+ one to find where the recording begins" — and cli-reference points readers there for the
43
+ answer, so three pages contradicted the fourth about how much of a file a command touches.
44
+
45
+ All three say what it does now, and link to the page that sets out which warnings follow. The
46
+ test asserts the behaviour first and the prose second: if `--info` ever really did stop reading
47
+ records, the pages would be right and this test is what should fail.
48
+
6
49
  ## 0.5.96
7
50
 
8
51
  ### Fixed: api.md said `readAnnotations` returns three counts, then named four
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edf2csv",
3
- "version": "0.5.96",
3
+ "version": "0.5.98",
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",