google/comprehensive-rust

Look at mdbook-keeper

Open

#175 aperta il 17 gen 2023

Vedi su GitHub
 (7 commenti) (0 reazioni) (0 assegnatari)Rust (2009 fork)batch import
good first issue

Metriche repository

Star
 (32.954 star)
Metriche merge PR
 (Merge medio 9g 23h) (36 PR mergiate in 30 g)

Descrizione

We currently have a number of code blocks marked with compile_fail: this is often because they depend on third-party crates which aren't available when running mdbook test.

We should look into using https://github.com/tfpk/mdbook-keeper/ to handle testing instead. It explicitly supports using third-party crates in code snippets.

Guida contributor

Direzione di ricerca
Valuta lo strumento mdbook keeper (https://github.com/tfpk/mdbook keeper) come sostituto degli attuali blocchi di codice compile fail nel corso comprehensive rust. Concentrati su come gestisce le crate di terze parti negli snippet di codice, confronta la sua configurazione e limitazioni con l'approccio di test mdbook esistente e documenta i risultati. Esamina i blocchi compile fail esistenti nel repository per comprenderne l'ambito. Discuti nel thread dell'issue eventuali domande o ostacoli identificati durante la valutazione.
Tech stack
rust
Dominio
documentationtesting
Tipo issue
Ricerca
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Rustmdbook
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60