FuelLabs/fuels-rs

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

Open

Aperta il 13 giu 2022

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

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

Tech stack
rust
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
blocked
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Rust basicsmdBookHTML/CSS fundamentals
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40
Direzione di ricerca
Investigate the linked upstream issue (rust lang/mdBook#1601) to understand the proposed fix for code snippet indentation. Explore the `examples` directory in fuels rs and the mdBook configuration files (e.g., book.toml) to see how the include macro is currently used. Implement a workaround or contribute to the upstream fix to strip extra indentation from included code snippets. Check the assignee's comments for any prior work or direction.