commercialhaskell/stack

Add `--all-packages`

Offen

#1.479 geöffnet am 08.12.2015

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (848 Forks)batch import
component: haddockhelp wantedtype: enhancement

Repository-Metriken

Stars
 (4.060 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

The stack haddock command currently generates documentation for the current build plan (which can include dependencies or not).

It would be good to have a flag like --all-packages so that haddocks would be generated for everything in the complete available package set.

Contributor Guide

Research-Richtung
Füge ein neues Flag ' all packages' zum Befehl 'stack haddock' hinzu. Das Flag soll Haddock Dokumentation für alle Pakete im vollständig verfügbaren Paketsatz generieren, nicht nur für den aktuellen Build Plan. Finde die Befehlsdefinition im Quellcode (wahrscheinlich in src/Stack/Build/Haddock.hs oder ähnlich). Füge das Flag zu den Befehlsoptionen hinzu und ändere die Logik, um über alle Pakete zu iterieren, wenn das Flag gesetzt ist. Teste die Implementierung.
Tech Stack
haskell
Domain
cli
Issue Type
Funktion
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.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
HaskellGitStack
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75