FuelLabs/fuels-rs

docs: improve upstream `md-book` code snippets display

Open

#388 aperta il 13 giu 2022

Vedi su GitHub
 (0 commenti) (1 reazione) (1 assegnatario)Rust (1360 fork)batch import
blockedenhancementgood first issue

Metriche repository

Star
 (43.211 star)
Metriche merge PR
 (Merge medio 17g) (1 PR mergiata in 30 g)

Descrizione

  • We now want all code that goes in the book to be tested (and put in the examples directory), so all code in The Book will soon be put there using the {{include path/to/file}} tag of md-book.

Problem: the formatting isn 't very nice, there's extra identation displayed because the code is inside a test function.

Fixing https://github.com/rust-lang/mdBook/issues/1601 would solve this! It would also be of benefit for all books!

Tagging @mitchmindtree for tooling consideration :smile:

Guida contributor

Direzione di ricerca
Indaga il problema mdBook #1601 relativo all'indentazione del tag include e applica una correzione per adattare la formattazione degli snippet di codice nel libro fuels rs.
Tech stack
rust
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
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
mdbook
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90