antonio-hickey/tradestation-rs

Fix ignored doc tests

Offen

#15 geöffnet am 10.08.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (6 Forks)auto 404
CIDocumentationGood First IssueHelp WantedRefactorStatus: Not StartedTests

Repository-Metriken

Stars
 (14 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuche die mit `ignore` markierten Doc Tests in den Rust Quelldateien. Identifiziere, welche ohne HTTP Anfragen kompiliert werden können, indem du das `ignore` Attribut entfernst und den Code so anpasst, dass nur Compile Zeit Konstrukte verwendet werden. Für Tests, die Laufzeit erfordern (z. B. mit Platzhalter Anmeldeinformationen), behalte sie als ignoriert, erwäge aber die Verwendung von `no run`, um die Kompilierung sicherzustellen. Folge dem Muster im verlinkten Commit, um die Tests umzugestalten.
Tech Stack
rust
Domain
apibackend
Issue Type
Test
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
RustGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70