docs(market): document finance_calendar pagination and fix examples - #1267
Open
hogan-yuan wants to merge 2 commits into
Open
hogan-yuan wants to merge 2 commits into
hogan-yuan wants to merge 2 commits into
Conversation
Add the count/offset/next pagination parameters to the calendar reference pages (split/dividend/earnings/ipo/macro/meeting/merge across en, zh-CN, zh-HK), matching the SDK change in longbridge/openapi#597. Also fix the request examples on the split/dividend/earnings/ipo/macro pages, which called non-existent per-category methods such as `split_calendar("AAPL.US")`; every language tab now calls `finance_calendar(CalendarCategory.X, start, end)`, consistent with the already-correct meeting/merge pages. Related: #1265
…mples - Add zh-CN / zh-HK translations for meeting_calendar and merge_calendar (4 files), which previously existed only in English. - Fix the misleading Response Example JSON on the split/dividend/earnings/ ipo/macro pages: macro now shows a real macro-economic event instead of a stock, per-day event counts corrected to match the single sample row, and the sample dates aligned to the request window. Salvaged from the stale #1125, which targeted the pre-`.mdx` docs and can no longer merge cleanly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Sync the calendar reference docs with the SDK change in longbridge/openapi#597 (which exposes the
finance_calendarpagination parameters), and roll up the outstanding calendar-doc fixes from the now-stale #1125.1. Pagination parameters
Add
count,offsetandnext(CalendarPageDirection:Later/Earlier) to the "SDK method parameters" table on every calendar page — split / dividend / earnings / ipo / macro / meeting / merge, acrossen,zh-CN,zh-HK.2. Fix broken request examples
The split / dividend / earnings / ipo / macro pages called non-existent per-category methods like
ctx.split_calendar("AAPL.US")(wrong name, and a symbol instead of a date range). Every language tab now calls the real method:with the correct category per page (earnings →
Report, macro →MacroData, etc.), consistent with the meeting / merge pages. Rust examples use the new 7-argument signature.3. Missing translations
Add
zh-CN/zh-HKmeeting_calendarandmerge_calendarpages (4 files) — they previously existed only in English.4. Response examples
Fix the misleading Response Example JSON: macro now shows a real macro-economic event instead of a stock, per-day event counts corrected to match the single sample row, and sample dates aligned to the request window.
Note on #1125
This supersedes #1125, which addressed the same broken examples and missing translations but targeted the pre-
.mdxdocs (the pages were since migrated byconvert-md-to-mdx.ts) and predates the pagination change, so it can no longer merge cleanly.Related: #1265