steveklabnik/rustdoc

Flag: markdown no TOC

Aberta

#147 aberto em 10 de ago. de 2017

Ver no GitHub
 (2 comentários) (0 reação) (0 responsável) (22 forks)github user discovery
E-Mediumbackendhelp wantedquestion

Métricas do repositório

Stars
 (104 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

This issue is part of https://github.com/steveklabnik/rustdoc/issues/125

--markdown-no-toc: don't generate a table of contents

Using this flag looks like this:

$ rustdoc README.md --markdown-no-toc

When generating documentation from a Markdown file, by default, rustdoc will generate a table of contents. This flag supresses that, and no TOC will be generated.

Should we keep this flag or not?

Guia do colaborador

Direção de pesquisa
Investigue a implementação atual da flag markdown no toc no repositório rust lang/rust. Procure por discussões ou issues sobre seu uso. Determine se a flag ainda é necessária ou se existem alternativas melhores. Forneça uma recomendação com justificativa.
Pilha de tecnologia
rust
Domain
documentationcli
Tipo Issue
Pesquisa
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
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.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Rust
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70