commercialhaskell/stack

haddock-error gets buried under warnings

Open

#2,605 opened on Sep 17, 2016

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Haskell (848 forks)batch import
awaiting pull requestcomponent: output (UI/UX)help wantedtype: enhancement

Repository metrics

Stars
 (4,060 stars)
PR merge metrics
 (Avg merge 17d 10h) (6 merged PRs in 30d)

Description

I am using

stack build --haddock --haddock-deps --haddock-arguments=--hyperlinked-source

This fails, because haddock gives an error on one of the source files (ghc does not). But it is hard to find out from stack's output:

  • last lines of stack output are just last lines of haddock warnings (and I have hundreds, like "missing documentation for ...") - I would expect a status message from stack saying that something failed
  • so, to check the status, and see the error, I have to scroll back on the screen (or in the log file, whose location was printed by stack, but to see that, I also have to wade back throught the warnings)

Contributor guide

Research direction
Look for the code that handles haddock output in the stack codebase. Find where warnings are printed and ensure errors are highlighted or printed at the end. Consider adding a final status message indicating success or failure.
Tech stack
haskell
Domain
clideveloper experiencebuild system
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Haskell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65