docs: document async client (AsyncDatamaxi) in README and docs#163
Merged
Conversation
- enable pymdownx.tabbed in mkdocs.yml - convert every endpoint page example into Sync/Async content tabs (17 pages) - slim docs/async.md to a concept page (install, lifecycle, pagination, ref) - drop invalid kwargs that neither sync nor async accept (cex.token.updates sort; cex.symbol cautions/delistings base; cex.symbol.volume exchange)
cex.token.updates accepts only page/limit/type; sort= would raise TypeError. Fixes the last instance (README API Reference, mirrored to docs/index.md via symlink). Closes #165.
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
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 #162
Summary
Documents the async client (
AsyncDatamaxi, added in #149/#150). Restructured per review feedback so async is not a bolt-on duplicate lump.mkdocs docs site — real Sync/Async content tabs
pymdownx.tabbed(alternate_style: true) inmkdocs.yml.index.mdquickstart. Each Async tab is the awaited twin of the Sync tab (fullasync with+asyncio.runscaffold per page).docs/async.mdfrom a per-endpoint duplicate into a concept page: install thedatamaxi[async]extra, lifecycle (async with/await client.aclose()), sameDATAMAXI_API_KEYenv var, coroutine/await rule, asyncnext_requestpagination, standaloneAsyncTelegram/AsyncNaver, and the::: datamaxi.aio.AsyncDatamaximkdocstrings reference. Points readers to the per-endpoint tabs. Still in the nav.README — no tabs (GitHub/PyPI render them as raw text)
datamaxi[async]install, one runnableasyncio.runexample, the lifecycle + asyncnext_requestcaveats, a one-line mention ofAsyncTelegram/AsyncNaver, and a pointer to the docs' Sync/Async tabs. API Reference stays sync-only. ToC keeps the "Async Client" entry.Correctness fix (both tabs)
While writing the Async twins I found existing docs examples passing kwargs that neither the sync nor async SDK accepts (would raise
TypeError):cex.token.updates(sort=...),cex.symbol.cautions(base=...),cex.symbol.delistings(base=...),cex.symbol.volume(exchange=...). Removed those kwargs from both the Sync and Async tabs so the examples are valid and true twins, and corrected the now-inaccurate cex-symbol note.Test plan
mkdocs build --strictpasses clean (only a pre-existing unrelated 'unrecognized relative link LICENSE' INFO in index.md); verified Sync/Async content tabs render in the built HTML.ast.parse.datamaxi/aio/*: coroutineawait, asyncnext_request, env-var handling, and the standalone Telegram/Naver clients.