Commit eea56f4
committed
docs: fix impossible OI dates, wrong imports, and an overclaim
Review found three defects that were teaching the wrong thing.
The sample OI timestamp was 2026-08-22T20:00:00Z presented as the prior
session close for a 2026-08-25 response. 2026-08-22 is a Saturday, so no
session closed then; the prior close for Tuesday the 25th is Monday the
24th. An impossible timestamp in a provenance example is worse than no
example, because the whole point of the field is teaching people - and
models - what a correct market calendar looks like. Corrected in 15
files, docs and test fixtures alike.
The TypeScript import named a package that does not exist. The live
package is `flashalpha` and the replay package is `flashalpha-historical`,
not `@flashalpha/sdk` and `@flashalpha/historical`. Both were wrong; only
one had been reported.
"Every successful response carries data_as_of" was true of the HTTP API
but not of this client. A few endpoints return a bare JSON array, where
the API puts the envelope in the X-Data-As-Of and X-Endpoint-Version
headers instead - and these clients return the parsed body only, so the
envelope is not reachable through those methods at all. The claim is now
scoped to JSON-object responses and the array case is documented as the
limitation it is rather than implied to work. On the replay service every
endpoint returns an object, so the unscoped claim holds there and says so.
AGENTS.md gains a freshness section, which is the file an agent actually
reads as operating rules and mentioned none of this. It maps each kind of
call to the feeds that answer it, so a null on an unrelated feed is not
treated as a problem; states that timestamps are UTC instants to compare
rather than parse; judges staleness against each feed's cadence rather
than the wall clock; and - the part that was missing entirely - says that
a null on a feed you depend on means freshness is UNKNOWN, so the answer
must be qualified or declined rather than presented as current. It also
warns that node can change between calls, so timestamps must not be
diffed across calls, and that endpoint_version is opaque deployment
metadata rather than a semver to parse.
Four .csproj.lscache files were committed by an over-broad git add in the
first commit. They declare themselves disposable; now untracked and
ignored.1 parent 83e743a commit eea56f4
2 files changed
Lines changed: 58 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
63 | 109 | | |
64 | 110 | | |
65 | 111 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
36 | | - | |
37 | | - | |
38 | | - | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
39 | 40 | | |
40 | 41 | | |
41 | 42 | | |
42 | 43 | | |
43 | 44 | | |
44 | | - | |
| 45 | + | |
45 | 46 | | |
46 | 47 | | |
47 | 48 | | |
| |||
82 | 83 | | |
83 | 84 | | |
84 | 85 | | |
85 | | - | |
86 | | - | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
87 | 93 | | |
88 | 94 | | |
89 | 95 | | |
| |||
0 commit comments