FuelLabs/fuels-rs

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

Open

#388 ouverte le 13 juin 2022

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

Métriques du dépôt

Stars
 (43 211 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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
Examinez le problème en amont lié (rust lang/mdBook#1601) pour comprendre la correction proposée pour l'indentation des extraits de code. Explorez le répertoire `examples` dans fuels rs et les fichiers de configuration mdBook (par exemple book.toml) pour voir comment la macro include est actuellement utilisée. Implémentez un contournement ou contribuez à la correction en amont pour supprimer l'indentation supplémentaire des extraits de code inclus. Vérifiez les commentaires de l'assigné pour tout travail ou orientation antérieure.
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.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Bloquée
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Rust basicsmdBookHTML/CSS fundamentals
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40