19001072405
87%

Ran 01 Nov 2025 06:51PM UTC

Jobs 1

Files 90

Run time 1min

Badge

Embed ▾

Committed 01 Nov 2025 06:44PM UTC coverage: 86.057% (+0.01%) from 86.045%

Build # 19001072405

Build Type

push

github

Committed by

web-flow

Commit Message

docs: add missing documentation for sync API functions (#327)

Add comprehensive documentation to 12 public functions that were
triggering missing_docs warnings in the sync feature build:

Orders module (src/orders/sync.rs):
- place_order: Submit order with event subscription
- cancel_order: Cancel order with status subscription
- global_cancel: Cancel all open orders
- next_valid_order_id: Get next valid order ID
- completed_orders: Request completed orders
- all_open_orders: Request all current open orders
- auto_open_orders: Request TWS order updates
- executions: Request execution data with filter
- exercise_options: Exercise options contracts

WSH module (src/wsh/sync.rs):
- wsh_metadata: Request Wall Street Horizon metadata
- wsh_event_data_by_contract: Request WSH events by contract
- wsh_event_data_by_filter: Request WSH events by filter

All functions now include:
- Summary description
- Arguments section with parameter details
- Returns section with success/error cases
- Links to TWS API docs where applicable

Fixes sync-only build warnings and improves API documentation quality.

Run Details

7542 of 8764 relevant lines covered (86.06%)

130.56 hits per line

Jobs

ID	Job ID	Ran	Files	Coverage
1	19001072405.1	01 Nov 2025 06:51PM UTC	90	86.06	GitHub Action Run

wboayue / rust-ibapi / 19001072405
87%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 19001072405

wboayue / rust-ibapi / 19001072405 87%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 19001072405

wboayue / rust-ibapi / 19001072405
87%

README BADGES
x