FuelLabs/fuels-rs

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

Open

#388 opened on 2022年6月13日

GitHub で見る
 (0 comments) (1 reaction) (1 assignee)Rust (43,211 stars) (1,360 forks)batch import
blockedenhancementgood first issue

説明

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

コントリビューターガイド

技術スタック
rust
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
blocked
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Rust basicsmdBookHTML/CSS fundamentals
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40
調査方針
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.