steveklabnik/rustdoc

Flag: markdown no TOC

Ouverte

#147 ouverte le 10 août 2017

Voir sur GitHub
 (2 commentaires) (0 réaction) (0 personne assignée) (22 forks)github user discovery
E-Mediumbackendhelp wantedquestion

Métriques du dépôt

Stars
 (104 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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?

Guide contributeur

Direction de recherche
Enquetez sur l'implémentation actuelle du drapeau markdown no toc dans le dépôt rust lang/rust. Recherchez des discussions ou des problèmes concernant son utilisation. Déterminez si le drapeau est toujours nécessaire ou s'il existe de meilleures alternatives. Fournissez une recommandation avec justification.
Stack technique
rust
Domaine
documentationcli
Type d'issue
Recherche
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rust
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70