FuelLabs/fuels-rs

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

Open

#388 aberto em 13 de jun. de 2022

Ver no GitHub
 (0 comments) (1 reaction) (1 assignee)Rust (1.360 forks)batch import
blockedenhancementgood first issue

Métricas do repositório

Stars
 (43.211 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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 upstream vinculado (rust lang/mdBook#1601) para entender a correção proposta para a indentação de trechos de código. Explore o diretório `examples` em fuels rs e os arquivos de configuração do mdBook (por exemplo, book.toml) para ver como a macro include está sendo usada atualmente. Implemente uma solução alternativa ou contribua para a correção upstream para remover a indentação extra dos trechos de código incluídos. Verifique os comentários do responsável para qualquer trabalho ou direção anterior.
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.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Bloqueado
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Rust basicsmdBookHTML/CSS fundamentals
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40