FuelLabs/fuels-rs

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

Open

#388 geöffnet am 13. Juni 2022

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (1 zugewiesene Person)Rust (1.360 Forks)batch import
blockedenhancementgood first issue

Repository-Metriken

Stars
 (43.211 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche das verlinkte Upstream Problem (rust lang/mdBook#1601), um den vorgeschlagenen Fix für die Einrückung von Code Snippets zu verstehen. Erkunde das `examples` Verzeichnis in fuels rs und die mdBook Konfigurationsdateien (z. B. book.toml), um zu sehen, wie das include Makro derzeit verwendet wird. Implementiere eine Problemumgehung oder trage zum Upstream Fix bei, um zusätzliche Einrückung aus eingebundenen Code Snippets zu entfernen. Überprüfe die Kommentare des Zuständigen auf vorherige Arbeiten oder Anweisungen.
Tech Stack
rust
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Blockiert
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Rust basicsmdBookHTML/CSS fundamentals
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40