Skip to content

Commit f281565

Browse files
userFRMclaude
andauthored
fix(docs): correct the C from_file snippet and clean stale surface references (#796)
The C migration example passed a null config to thetadatadx_client_connect_from_file, but the C ABI requires a non-null config handle and hard-fails otherwise, so the snippet was a copy-paste failure; pass a production config handle as the other before/after C blocks do. Update the bug-report template's example method names to the role-namespaced client surface, and rename the source-docs framing CI job and step so the public Actions UI carries neutral wording. Co-authored-by: Claude <noreply@anthropic.com>
1 parent d71fd35 commit f281565

3 files changed

Lines changed: 5 additions & 4 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A clear and concise description of the bug.
2121

2222
## Endpoint / Method Affected
2323

24-
Which API endpoint or client method is involved? (e.g., `ThetaDataDxClient::stock_history_eod`, `ThetaDataDxClient::subscribe(Contract::stock("AAPL").quote())`)
24+
Which API endpoint or client method is involved? (e.g., `client.historical.stock_history_eod`, `client.stream.subscribe(Contract.stock("AAPL").quote())`)
2525

2626
## Steps to Reproduce
2727

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,15 +135,15 @@ jobs:
135135
python3 scripts/check_doc_defaults.py
136136
137137
no-re-framing:
138-
name: Source docs reverse-engineering framing
138+
name: Source docs framing hygiene
139139
runs-on: ubuntu-latest
140140
timeout-minutes: 5
141141
steps:
142142
- uses: actions/checkout@v6
143143
- uses: actions/setup-python@v6
144144
with:
145145
python-version: "3.12"
146-
- name: Reverse-engineering framing detector
146+
- name: Source docs framing detector
147147
run: |
148148
python3 scripts/check_no_re_framing.py --selftest
149149
python3 scripts/check_no_re_framing.py

docs-site/docs/migration/v12-to-v13.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,8 @@ auto client = thetadatadx::Client::from_file("creds.txt");
304304
```
305305

306306
```c
307-
ThetaDataDxClient* client = thetadatadx_client_connect_from_file("creds.txt", NULL);
307+
ThetaDataDxConfig* cfg = thetadatadx_config_production();
308+
ThetaDataDxClient* client = thetadatadx_client_connect_from_file("creds.txt", cfg);
308309
```
309310

310311
## Flat files are restricted to the vendor datasets

0 commit comments

Comments
 (0)