Ticket #175: prettier-haddock-coverage-info.dpatch

1 patch for repository http://code.haskell.org/haddock:

Wed Jun  1 19:41:16 CEST 2011  iridcode@gmail.com
  * prettier haddock coverage info
  The new coverage info rendering uses less horizontal space. This reduces the
  number of unnecessary line-wrappings. Moreover, the most important information,
  how much has been documented already, is now put up front. Hopefully, this
  makes it more likely that a library author is bothered by the low coverage of
  his modules and fixes that issue ;-)


New patches:

[prettier haddock coverage info
iridcode@gmail.com**20110601174116
 Ignore-this: 5c687ca8ba02ccb3fe946ea30ee03aea
 The new coverage info rendering uses less horizontal space. This reduces the
 number of unnecessary line-wrappings. Moreover, the most important information,
 how much has been documented already, is now put up front. Hopefully, this
 makes it more likely that a library author is bothered by the low coverage of
 his modules and fixes that issue ;-)
] {
hunk ./src/Haddock/Interface.hs 145
 createIfaces :: Verbosity -> [Flag] -> InstIfaceMap -> ModuleGraph -> Ghc [Interface]
 createIfaces verbosity flags instIfaceMap mods = do
   let sortedMods = flattenSCCs $ topSortModuleGraph False mods Nothing
+  out verbosity normal "Haddock coverage:"
   (ifaces, _) <- foldM f ([], Map.empty) sortedMods
   return (reverse ifaces)
   where
hunk ./src/Haddock/Interface.hs 166
     liftIO $ mapM_ putStrLn msg
     let (haddockable, haddocked) = ifaceHaddockCoverage interface
         percentage = round (fromIntegral haddocked * 100 / fromIntegral haddockable :: Double) :: Int
-        coveragemsg = printf "haddock coverage for %s: %7s %3d%%"
+        coveragemsg = printf " %3d%% (%3d /%3d) in '%s'"
+                        percentage haddocked haddockable
                         (ifaceOrigFilename interface)
hunk ./src/Haddock/Interface.hs 169
-                        (printf "%d/%d" haddocked haddockable ::  String)
-                        percentage
     out verbosity normal coveragemsg
     interface' <- liftIO $ evaluate interface
     return (Just interface')
}

Context:

[Indentation
David Waern <david.waern@gmail.com>**20110522220911
 Ignore-this: 55246d0c1b3892320426342c8a99f1fb
] 
[Fix some stylistic issues in mkExportItems
David Waern <david.waern@gmail.com>**20110522215352
 Ignore-this: 38aef2684e6f98b7bda0fb0867d222b
] 
[Break out fullContentsOf, give it a better name and some documentation
David Waern <david.waern@gmail.com>**20110522214021
 Ignore-this: 9b39ae4d437f52750771d38d25f37c70
 
 The documentation describes how we want this function to eventually behave,
 once we have fixed a few problems with the current implementation.
] 
[Fix a bug
David Waern <david.waern@gmail.com>**20110522213903
 Ignore-this: ff4ea57f9ea8f12067ee03d002e103f9
] 
[We don't need to send DocOptions nor a flag to mkExportItems
David Waern <david.waern@gmail.com>**20110522014544
 Ignore-this: 5eed2837db4697c5a5597524e4ad5a86
] 
[Use cabal's test suite support to run the test suite
David Waern <david.waern@gmail.com>**20110522154152
 Ignore-this: 5e91a2cfe96f9099bf80b84db9c4d7f4
 
 This gives up proper dependency tracking of the test script.
] 
[Improve a haddock comment
David Waern <david.waern@gmail.com>**20110521235756
 Ignore-this: de1de57aa9f180c7a207ac55fe1db21d
] 
[Add documentation for "support for blank lines in the result of examples"
Simon Hengel <simon.hengel@wiktory.org>**20110408173650
 Ignore-this: 7972573bbf0b1608a0405e0362551599
] 
[Add support for blank lines in the result of examples
Simon Hengel <simon.hengel@wiktory.org>**20110408170928
 Ignore-this: 157d79dc570e3cc1466ddb021d11b75f
 
 Result lines that only contain the string "<BLANKLINE>" are treated as a blank
 line.
] 
[Update Haddock version in *.html.ref
Simon Hengel <simon.hengel@wiktory.org>**20110408162849
 Ignore-this: 32df84351b930569a1c51d4089247eec
] 
[Update runtests.hs for GHC 7.0.2
Simon Hengel <simon.hengel@wiktory.org>**20110408162536
 Ignore-this: 4c20bd28ad6b668f716300c238c59d3e
] 
[Set unit tests back to work
Simon Hengel <simon.hengel@wiktory.org>**20110408160124
 Ignore-this: 3cb689ad45aeef8737c530c20009d513
 
 Here "ghci>" was still used instead of ">>>".
] 
[Set shell script for unit tests back to work
Simon Hengel <simon.hengel@wiktory.org>**20110408155301
 Ignore-this: 5f03d2f8cb87454ac8a089ad8c103f73
] 
[TAG 2.9.2-actual
David Waern <david.waern@gmail.com>**20110310224750
 Ignore-this: e868ef36a55bd75215c911fd3e790488
] 
[Fix build with ghc 7.0.1
David Waern <david.waern@gmail.com>**20110310224731
 Ignore-this: 54deb5ad05948ee54c831bccca4aa27f
] 
[Update CHANGES
David Waern <david.waern@gmail.com>**20110310224713
 Ignore-this: 632904f16e0c1a583a68cb470b3c9fd8
] 
[TAG GHC 7.0.2 release
Ian Lynagh <igloo@earth.li>**20110303150237
 Ignore-this: 7d2d831557f86917b610b68b53c73ccf
] 
[Update Haddock to reflect change in hs_tyclds field of HsGroup
simonpj@microsoft.com**20110110173112
 Ignore-this: 5e6d569179da057454f23263344bcdc6
] 
[Name the haddock script haddock-ghc-7.0.2 instead of haddock-7.0.2; #4882
Ian Lynagh <igloo@earth.li>**20110107230657
 "7.0.2" looked like a haddock version number before
] 
[TAG 2.9.2
David Waern <david.waern@gmail.com>**20110108140707
 Ignore-this: 9d9e0a5acbeb5ba338145578fec494ab
] 
[Bump version
David Waern <david.waern@gmail.com>**20110108140644
 Ignore-this: ca23159d2ba1168a8b6c97454a2a67de
] 
[Follow GHC build system changes
Ian Lynagh <igloo@earth.li>**20110107023311
 Ignore-this: dc59b6a8c15641bde334926445a3efdd
] 
[Fix spelling error - contributed by Marco Silva
David Waern <david.waern@gmail.com>**20110122160944
 Ignore-this: 41872c8ace5814c45dd8baeb016be63a
] 
[Put title outside doc div when HTML:fying title+prologue
David Waern <david.waern@gmail.com>**20110122000035
 Ignore-this: 5f3cd275489f06248f814c6f67fd6709
 
 Avoids indenting the title, and makes more sense since the title
 is not a doc string anyway.
] 
[Write hoogle output in utf8; fixes GHC build on Windows
Ian Lynagh <igloo@earth.li>**20110105182427
 Ignore-this: 5c69fa9f33227e4df76524c8fbeef34d
] 
[TAG 2.9.1
David Waern <david.waern@gmail.com>**20101219180649
 Ignore-this: 24e440e93a68f24bc93d3906bf93c040
] 
Patch bundle hash:
f2a48921f00eece632c20c4d0d9bb8cf9d967972