steveklabnik/rustdoc

Flag: markdown no TOC

Offen

#147 geöffnet am 10.08.2017

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen) (22 Forks)github user discovery
E-Mediumbackendhelp wantedquestion

Repository-Metriken

Stars
 (104 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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?

Contributor Guide

Research-Richtung
Untersuchen Sie die aktuelle Implementierung des Flags markdown no toc im rust lang/rust Repository. Suchen Sie nach Diskussionen oder Problemen zur Nutzung. Bestimmen Sie, ob das Flag noch benötigt wird oder ob es bessere Alternativen gibt. Geben Sie eine Empfehlung mit Begründung.
Tech Stack
rust
Domain
documentationcli
Issue Type
Recherche
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70