You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(v9.1.0): close codex r14 audit findings — repo URL drift, stale subscribe_* docs, trailing whitespace
Four findings from r14, all closed.
1. **Repo URL drift in user-facing files** — the rename pass earlier
in this branch had also rewritten every literal `userFRM/ThetaDataDx`
GitHub URL to `userFRM/ThetaDataDxClient`, breaking every badge,
homepage link, repository-link, and changelog `[X.Y.Z]: ...`
reference. The actual remote is `userFRM/ThetaDataDx`. Reverted
the URL part of the rewrite across `README.md`, `CHANGELOG.md`,
every `Cargo.toml` `homepage`/`repository`, `sdks/python/pyproject.toml`,
the docs-site `flatfiles/{api-reference,index}.md`, the GitHub
workflows, and `docs/ATTRIBUTION.md`. The Rust client type stays
`ThetaDataDxClient` (correct rename target); only the GitHub
project / repo identifier is reverted.
Also fixed two prose drift sites: `README.md` H1 (`# ThetaDataDxClient`
→ `# ThetaDataDx`, the project name) and the
`tools/mcp/Cargo.toml` description ("MCP server for ThetaDataDxClient"
→ "MCP server for ThetaDataDx").
2. **Stale `subscribe_*` family in public docs / docstrings** — three
sites still referred to the removed shape:
- `docs-site/docs/streaming/connection.md`: "You can safely call
`subscribe_*()` from any thread" → "You can safely call
`subscribe(spec)` / `unsubscribe(spec)` from any thread".
- `sdks/cpp/include/thetadx.hpp` `UnifiedClient` class doc-comment:
told users to drive raw `_subscribe_*` C ABI through `get()`;
now describes the polymorphic `subscribe(spec)` /
`unsubscribe(spec)` and `start_streaming_iter()` entries the
C++ wrapper actually exposes, and only routes
`tdx_unified_set_callback` / `tdx_unified_await_drain` through
`get()` (the genuine FFI-only operations).
- `crates/thetadatadx/src/fpss/mod.rs` `FpssClient` docstring's
"Thread safety" section: "The `subscribe_*` and `unsubscribe_*`
methods send commands..." → "The polymorphic `subscribe(spec)` /
`unsubscribe(spec)` methods send commands...".
3. **TS `index.js` stale `9.0.2` version pin** — `npm run build`
regenerated the napi loader against the bumped 9.1.0 package +
optional-deps; six guard sites in `sdks/typescript/index.js`
refreshed from `9.0.2` to `9.1.0`.
4. **Trailing whitespace in generated artifacts** — empty doc-
comment lines in `crates/thetadatadx/build_support/sdk_surface/
common.rs::push_rust_doc_comment` and `push_cpp_doc_comment`
were emitting `/// ` and ` * ` with a single trailing space.
Both helpers now special-case empty input lines and write
bare `///` / ` *`. Re-ran `generate_sdk_surfaces`; `git diff
--check origin/main..HEAD` is now clean across the generated
tree (`sdks/cpp/include/fpss.hpp.inc`,
`sdks/python/src/_generated/streaming_methods.rs`,
`sdks/typescript/src/_generated/streaming_methods.rs`).
Pre-push pipeline: cargo fmt --all -- --check, clippy --workspace
--locked -- -D warnings, test --workspace --locked,
generate_sdk_surfaces --check, deny check, npm run build / test.
Copy file name to clipboardExpand all lines: docs-site/docs/flatfiles/api-reference.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ The FLATFILES surface accepts three orthogonal inputs:
9
9
|`date`|`YYYYMMDD` string | Single trading date. Flat files are **per-day** blobs; date ranges are not supported. |
10
10
|`format`|`csv`, `jsonl`| On-disk encoding when writing bytes to a file. |
11
11
12
-
Not every `(sec_type, req_type)` combination is supported by ThetaData — see the [ROADMAP](https://github.com/userFRM/ThetaDataDxClient/blob/main/docs/ROADMAP.md#flatfiles--surface-status) for the verified subset. Unsupported combinations surface as a typed `Error::FlatFilesUnavailable` in Rust (or its language-specific equivalent).
12
+
Not every `(sec_type, req_type)` combination is supported by ThetaData — see the [ROADMAP](https://github.com/userFRM/ThetaDataDx/blob/main/docs/ROADMAP.md#flatfiles--surface-status) for the verified subset. Unsupported combinations surface as a typed `Error::FlatFilesUnavailable` in Rust (or its language-specific equivalent).
Copy file name to clipboardExpand all lines: docs-site/docs/flatfiles/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,6 +47,6 @@ Flat files are large. A single option-quote daily blob can exceed 100 MB. Plan a
47
47
| REST server |`GET /v3/flatfile/{sec_type}/{req_type}?date=YYYYMMDD&format=csv\|jsonl` and `POST /v3/flatfile/request`. |
48
48
| MCP server |`tdx_flatfile_*` tools mirroring the Rust convenience methods. |
49
49
50
-
The full per-binding matrix lives in [`docs/ROADMAP.md`](https://github.com/userFRM/ThetaDataDxClient/blob/main/docs/ROADMAP.md#binding-coverage-matrix).
50
+
The full per-binding matrix lives in [`docs/ROADMAP.md`](https://github.com/userFRM/ThetaDataDx/blob/main/docs/ROADMAP.md#binding-coverage-matrix).
51
51
52
52
Continue to [Quickstart](./quickstart) for code samples, then [API reference](./api-reference) for the full method signatures.
Copy file name to clipboardExpand all lines: docs-site/docs/streaming/connection.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -239,7 +239,7 @@ Disruptor consumer thread
239
239
+-- your callback(FnMut(&FpssEvent))
240
240
```
241
241
242
-
You can safely call `subscribe_*()` from any thread -- the command is sent through an `mpsc` channel and executed by the I/O thread.
242
+
You can safely call `subscribe(spec)` / `unsubscribe(spec)` from any thread -- the command is sent through an `mpsc` channel and executed by the I/O thread.
0 commit comments