antonio-hickey/tradestation-rs

Fix ignored doc tests

Ouverte

#15 ouverte le 10 août 2025

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Rust (6 forks)auto 404
CIDocumentationGood First IssueHelp WantedRefactorStatus: Not StartedTests

Métriques du dépôt

Stars
 (14 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Inspectez les tests de doc marqués avec `ignore` dans les fichiers source Rust. Identifiez ceux qui peuvent être compilés sans effectuer de requêtes HTTP en supprimant l'attribut `ignore` et en ajustant le code pour utiliser uniquement des constructions au moment de la compilation. Pour les tests qui nécessitent l'exécution (par exemple avec des identifiants factices), gardez les ignorés mais envisagez d'utiliser `no run` pour garantir leur compilation. Suivez le modèle montré dans le commit lié pour refactoriser les tests.
Stack technique
rust
Domaine
apibackend
Type d'issue
Test
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
RustGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70