edfcore 0.4.334 → 0.4.336
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.
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/docs/CHANGELOG.md +30 -0
- package/package.json +1 -1
- package/src/constants.ts +1 -1
package/dist/constants.d.ts
CHANGED
|
@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
|
|
|
109
109
|
readonly reserved: 224;
|
|
110
110
|
};
|
|
111
111
|
/** Published package version. Kept in sync with package.json by a test. */
|
|
112
|
-
export declare const VERSION = "0.4.
|
|
112
|
+
export declare const VERSION = "0.4.336";
|
|
113
113
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.js
CHANGED
package/docs/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,36 @@ alone does not tell you whether you were affected.
|
|
|
6
6
|
edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
|
|
7
7
|
defect; those are called out below.
|
|
8
8
|
|
|
9
|
+
## 0.4.336
|
|
10
|
+
|
|
11
|
+
- **Fixed** wrong advice on `quick-start.md`. It said an annotation carries its onset "three ways"
|
|
12
|
+
and then named `onsetSecondsFromFirstRecord`, `onsetSecondsFromHeaderStart` and `onsetTicks` —
|
|
13
|
+
one float from each axis and a bigint from only one of them — closing with "Print the seconds;
|
|
14
|
+
compare the ticks." Followed literally on a file that declares a sub-second start offset, that
|
|
15
|
+
prints the rebased seconds and compares the header-axis ticks: on a 0.5 s offset, an event shown
|
|
16
|
+
at 1.25 s and tested at 1.75 s, silently.
|
|
17
|
+
- There are four fields, two per axis, and `annotations.md` has had them right in a table all
|
|
18
|
+
along. The quick start now names both members of both pairs, keeps the "print the seconds,
|
|
19
|
+
compare the ticks" advice with "from the same axis" attached, and says what the two axes differ
|
|
20
|
+
by. Checked on a file with an offset and again on one without, where the two collapse — which is
|
|
21
|
+
why this was easy to miss.
|
|
22
|
+
- This is the same shape as the defect the rename in 0.3.0 exists to prevent: two quantities that
|
|
23
|
+
agree on an ordinary file and part company on the one that matters.
|
|
24
|
+
|
|
25
|
+
## 0.4.335
|
|
26
|
+
|
|
27
|
+
- **Added** a check over the console output `quick-start.md` prints. Between two `text` blocks the
|
|
28
|
+
page pins the whole shape of a read — variant, record geometry, three channels with their kinds
|
|
29
|
+
and sample counts, and `2560 samples, 6040 bytes read` — and the fixture is now built from the
|
|
30
|
+
block's own description of the file rather than from a fixture that happens to resemble it.
|
|
31
|
+
- The byte count is the number worth holding. The page stops to explain that 6040 "is more than
|
|
32
|
+
the 5120 bytes those 2560 samples occupy", because a record is the smallest readable unit and
|
|
33
|
+
every channel is interleaved into it — so the overhead a reader budgets from this page follows
|
|
34
|
+
from the annotation channel's width, three lines further up the same block. That subtraction is
|
|
35
|
+
checked, not just the total.
|
|
36
|
+
- The individual sample values are deliberately not checked. They come from a recording nobody
|
|
37
|
+
here has, and a fixture reproducing them would be asserting against its own generator.
|
|
38
|
+
|
|
9
39
|
## 0.4.334
|
|
10
40
|
|
|
11
41
|
- **Added** a check over the `validateHeader` table on `api-validate.md`, which was one of the four
|
package/package.json
CHANGED
package/src/constants.ts
CHANGED