antonio-hickey/tradestation-rs

Fix ignored doc tests

Open

#15 opened on Aug 10, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (6 forks)auto 404
CIDocumentationGood First IssueHelp WantedRefactorStatus: Not StartedTests

Repository metrics

Stars
 (14 stars)
PR merge metrics
 (PR metrics pending)

Description

There's a bunch of doc tests which are marked to be ignored, for example:

https://github.com/antonio-hickey/tradestation-rs/blob/c3a9d730398ea83b632177e4ab32b37ce731ad02/src/execution.rs#L74-L107

These need some slight refactoring so that they compile and pass correctly. We still want some partial ignoring like runtime tests for most of them, because they have fake placeholder credentials in the tests. They can't be tested without mocking the HTTP request's which is out of scope for doc examples.

See this commit for an example: https://github.com/antonio-hickey/tradestation-rs/commit/fd79d4c25d70eef9ff5e6b6db66db134ac4fee94

Contributor guide

Research direction
Inspect the doc tests marked with `ignore` in the Rust source files. Identify which ones can be made to compile without making HTTP requests by removing the `ignore` attribute and adjusting the code to use only compile time constructs. For tests that require runtime (e.g., with placeholder credentials), keep them ignored but consider using `no run` to ensure they compile. Follow the pattern shown in the linked commit to refactor the tests.
Tech stack
rust
Domain
apibackend
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70