FuelLabs/fuels-rs

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

Ouverte

#388 ouverte le 13 juin 2022

Voir sur GitHub
 (0 commentaire) (1 réaction) (1 personne assignée)Rust (1 360 forks)batch import
blockedenhancementgood first issue

Métriques du dépôt

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

Description

  • 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:

Guide contributeur

Direction de recherche
Enquetez sur le problème mdBook #1601 concernant l'indentation de la balise include et appliquez un correctif pour ajuster le formatage des extraits de code dans le livre fuels rs.
Stack technique
rust
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
mdbook
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90