antonio-hickey/tradestation-rs

Fix ignored doc tests

Aberta

#15 aberto em 10 de ago. de 2025

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Rust (6 forks)auto 404
CIDocumentationGood First IssueHelp WantedRefactorStatus: Not StartedTests

Métricas do repositório

Stars
 (14 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Inspecione os testes de doc marcados com `ignore` nos arquivos de origem Rust. Identifique quais podem ser compilados sem fazer solicitações HTTP removendo o atributo `ignore` e ajustando o código para usar apenas construções em tempo de compilação. Para testes que exigem tempo de execução (por exemplo, com credenciais de espaço reservado), mantenha os ignorados, mas considere usar `no run` para garantir que compilem. Siga o padrão mostrado no commit vinculado para refatorar os testes.
Pilha de tecnologia
rust
Domain
apibackend
Tipo Issue
Teste
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
RustGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70