FuelLabs/fuels-rs

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

Aberta

#388 aberto em 13 de jun. de 2022

Ver no GitHub
 (0 comentário) (1 reação) (1 responsável)Rust (1.360 forks)batch import
blockedenhancementgood first issue

Métricas do repositório

Stars
 (43.211 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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:

Guia do colaborador

Direção de pesquisa
Investigue o problema mdBook #1601 sobre indentação da tag include e aplique uma correção para ajustar a formatação dos trechos de código no livro fuels rs.
Pilha de tecnologia
rust
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
mdbook
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90