-
-
Notifications
You must be signed in to change notification settings - Fork 197
watchOrderBook docs omit limit parameter that the code accepts #163
Copy link
Copy link
Labels
P3: lowapi-consistencyCCXT/PMXT API consistency audit findingsCCXT/PMXT API consistency audit findingsbugSomething isn't workingSomething isn't workingcoreCore sidecar/server logicCore sidecar/server logicdocumentationImprovements or additions to documentationImprovements or additions to documentationeffort: smallgood first issueGood for newcomersGood for newcomers
Metadata
Metadata
Assignees
Labels
P3: lowapi-consistencyCCXT/PMXT API consistency audit findingsCCXT/PMXT API consistency audit findingsbugSomething isn't workingSomething isn't workingcoreCore sidecar/server logicCore sidecar/server logicdocumentationImprovements or additions to documentationImprovements or additions to documentationeffort: smallgood first issueGood for newcomersGood for newcomers
Type
Fields
Give feedbackNo fields configured for issues without a type.
Inconsistency
The PMXT documentation for
watchOrderBookdoes not mention thelimitparameter in its parameter table, but the TypeScript core implementation acceptslimit?: numberas a second argument.Current (PMXT)
TypeScript core —
core/src/BaseExchange.ts:Documentation (
docs/llms-full.txt) — parameter table forwatchOrderBook:Expected (CCXT convention)
/tmp/ccxt/ts/src/base/Exchange.ts:CCXT documents
limitas a standard parameter for controlling the depth of the streamed order book. PMXT's docs should document thelimitparameter, and the method should also acceptparams = {}.Impact
Callers reading the documentation will not know that
limitis available for controlling book depth. Any CCXT-compatible code passingwatchOrderBook(symbol, limit)will work by accident (since the positional arg aligns), but callers passingwatchOrderBook(symbol, limit, params)will haveparamssilently ignored.Found by automated PMXT ↔ CCXT API consistency audit