docs: document liquidation, open_interest, and cex.symbol surfaces#110
Merged
martinkersner merged 1 commit intoJun 30, 2026
Merged
Conversation
Document the three undocumented client surfaces (client.liquidation, client.open_interest, client.cex.symbol) with usage snippets derived from actual method signatures and mkdocstrings blocks. Add top-level Liquidation/Open Interest nav entries and Symbol under the CEX group. Closes #108
martinkersner
deleted the
issue-108-document-liquidation-open-interest-symbol
branch
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.
Closes #108
Summary
Three public client surfaces had no docs. Adds doc pages + nav entries, basing every snippet on the actual method signatures in code.
docs/liquidation.md—::: datamaxi.datamaxi.Liquidation(client.liquidation):__call__,feed,heatmap,map,symbol_historydocs/open-interest.md—::: datamaxi.datamaxi.OpenInterest(client.open_interest):__call__,list,overview,summary,history_aggregateddocs/cex-symbol.md—::: datamaxi.datamaxi.CexSymbol(client.cex.symbol):metadata,tags,cautions,delistings,volume,oi,oi_stats,liquidationmkdocs.yml: top-levelLiquidation+Open Interest;Symbolunder theCEX:group.Structure mirrors existing pages (funding-rate.md etc.): intro + usage snippet + mkdocstrings block. Drift sweep: no DEX refs remain; all method references in existing pages verified against source — no stale/renamed signatures found, so no other changes.
Test plan
requirements/requirements-dev.txt+ editable package into a venv.mkdocs build --strictfrom the worktree root: built in ~10s, exit 0, zero warnings (strict fails on any missing mkdocstrings reference, so the three:::blocks resolve).