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

File prettier-haddock-coverage-info.dpatch, 6.1 kB (added by SimonMeier, 4 years ago)
Line 
11 patch for repository http://code.haskell.org/haddock:
2
3Wed Jun  1 19:41:16 CEST 2011  iridcode@gmail.com
4  * prettier haddock coverage info
5  The new coverage info rendering uses less horizontal space. This reduces the
6  number of unnecessary line-wrappings. Moreover, the most important information,
7  how much has been documented already, is now put up front. Hopefully, this
8  makes it more likely that a library author is bothered by the low coverage of
9  his modules and fixes that issue ;-)
10
11
12New patches:
13
14[prettier haddock coverage info
15iridcode@gmail.com**20110601174116
16 Ignore-this: 5c687ca8ba02ccb3fe946ea30ee03aea
17 The new coverage info rendering uses less horizontal space. This reduces the
18 number of unnecessary line-wrappings. Moreover, the most important information,
19 how much has been documented already, is now put up front. Hopefully, this
20 makes it more likely that a library author is bothered by the low coverage of
21 his modules and fixes that issue ;-)
22] {
23hunk ./src/Haddock/Interface.hs 145
24 createIfaces :: Verbosity -> [Flag] -> InstIfaceMap -> ModuleGraph -> Ghc [Interface]
25 createIfaces verbosity flags instIfaceMap mods = do
26   let sortedMods = flattenSCCs $ topSortModuleGraph False mods Nothing
27+  out verbosity normal "Haddock coverage:"
28   (ifaces, _) <- foldM f ([], Map.empty) sortedMods
29   return (reverse ifaces)
30   where
31hunk ./src/Haddock/Interface.hs 166
32     liftIO $ mapM_ putStrLn msg
33     let (haddockable, haddocked) = ifaceHaddockCoverage interface
34         percentage = round (fromIntegral haddocked * 100 / fromIntegral haddockable :: Double) :: Int
35-        coveragemsg = printf "haddock coverage for %s: %7s %3d%%"
36+        coveragemsg = printf " %3d%% (%3d /%3d) in '%s'"
37+                        percentage haddocked haddockable
38                         (ifaceOrigFilename interface)
39hunk ./src/Haddock/Interface.hs 169
40-                        (printf "%d/%d" haddocked haddockable ::  String)
41-                        percentage
42     out verbosity normal coveragemsg
43     interface' <- liftIO $ evaluate interface
44     return (Just interface')
45}
46
47Context:
48
49[Indentation
50David Waern <david.waern@gmail.com>**20110522220911
51 Ignore-this: 55246d0c1b3892320426342c8a99f1fb
52]
53[Fix some stylistic issues in mkExportItems
54David Waern <david.waern@gmail.com>**20110522215352
55 Ignore-this: 38aef2684e6f98b7bda0fb0867d222b
56]
57[Break out fullContentsOf, give it a better name and some documentation
58David Waern <david.waern@gmail.com>**20110522214021
59 Ignore-this: 9b39ae4d437f52750771d38d25f37c70
60 
61 The documentation describes how we want this function to eventually behave,
62 once we have fixed a few problems with the current implementation.
63]
64[Fix a bug
65David Waern <david.waern@gmail.com>**20110522213903
66 Ignore-this: ff4ea57f9ea8f12067ee03d002e103f9
67]
68[We don't need to send DocOptions nor a flag to mkExportItems
69David Waern <david.waern@gmail.com>**20110522014544
70 Ignore-this: 5eed2837db4697c5a5597524e4ad5a86
71]
72[Use cabal's test suite support to run the test suite
73David Waern <david.waern@gmail.com>**20110522154152
74 Ignore-this: 5e91a2cfe96f9099bf80b84db9c4d7f4
75 
76 This gives up proper dependency tracking of the test script.
77]
78[Improve a haddock comment
79David Waern <david.waern@gmail.com>**20110521235756
80 Ignore-this: de1de57aa9f180c7a207ac55fe1db21d
81]
82[Add documentation for "support for blank lines in the result of examples"
83Simon Hengel <simon.hengel@wiktory.org>**20110408173650
84 Ignore-this: 7972573bbf0b1608a0405e0362551599
85]
86[Add support for blank lines in the result of examples
87Simon Hengel <simon.hengel@wiktory.org>**20110408170928
88 Ignore-this: 157d79dc570e3cc1466ddb021d11b75f
89 
90 Result lines that only contain the string "<BLANKLINE>" are treated as a blank
91 line.
92]
93[Update Haddock version in *.html.ref
94Simon Hengel <simon.hengel@wiktory.org>**20110408162849
95 Ignore-this: 32df84351b930569a1c51d4089247eec
96]
97[Update runtests.hs for GHC 7.0.2
98Simon Hengel <simon.hengel@wiktory.org>**20110408162536
99 Ignore-this: 4c20bd28ad6b668f716300c238c59d3e
100]
101[Set unit tests back to work
102Simon Hengel <simon.hengel@wiktory.org>**20110408160124
103 Ignore-this: 3cb689ad45aeef8737c530c20009d513
104 
105 Here "ghci>" was still used instead of ">>>".
106]
107[Set shell script for unit tests back to work
108Simon Hengel <simon.hengel@wiktory.org>**20110408155301
109 Ignore-this: 5f03d2f8cb87454ac8a089ad8c103f73
110]
111[TAG 2.9.2-actual
112David Waern <david.waern@gmail.com>**20110310224750
113 Ignore-this: e868ef36a55bd75215c911fd3e790488
114]
115[Fix build with ghc 7.0.1
116David Waern <david.waern@gmail.com>**20110310224731
117 Ignore-this: 54deb5ad05948ee54c831bccca4aa27f
118]
119[Update CHANGES
120David Waern <david.waern@gmail.com>**20110310224713
121 Ignore-this: 632904f16e0c1a583a68cb470b3c9fd8
122]
123[TAG GHC 7.0.2 release
124Ian Lynagh <igloo@earth.li>**20110303150237
125 Ignore-this: 7d2d831557f86917b610b68b53c73ccf
126]
127[Update Haddock to reflect change in hs_tyclds field of HsGroup
128simonpj@microsoft.com**20110110173112
129 Ignore-this: 5e6d569179da057454f23263344bcdc6
130]
131[Name the haddock script haddock-ghc-7.0.2 instead of haddock-7.0.2; #4882
132Ian Lynagh <igloo@earth.li>**20110107230657
133 "7.0.2" looked like a haddock version number before
134]
135[TAG 2.9.2
136David Waern <david.waern@gmail.com>**20110108140707
137 Ignore-this: 9d9e0a5acbeb5ba338145578fec494ab
138]
139[Bump version
140David Waern <david.waern@gmail.com>**20110108140644
141 Ignore-this: ca23159d2ba1168a8b6c97454a2a67de
142]
143[Follow GHC build system changes
144Ian Lynagh <igloo@earth.li>**20110107023311
145 Ignore-this: dc59b6a8c15641bde334926445a3efdd
146]
147[Fix spelling error - contributed by Marco Silva
148David Waern <david.waern@gmail.com>**20110122160944
149 Ignore-this: 41872c8ace5814c45dd8baeb016be63a
150]
151[Put title outside doc div when HTML:fying title+prologue
152David Waern <david.waern@gmail.com>**20110122000035
153 Ignore-this: 5f3cd275489f06248f814c6f67fd6709
154 
155 Avoids indenting the title, and makes more sense since the title
156 is not a doc string anyway.
157]
158[Write hoogle output in utf8; fixes GHC build on Windows
159Ian Lynagh <igloo@earth.li>**20110105182427
160 Ignore-this: 5c69fa9f33227e4df76524c8fbeef34d
161]
162[TAG 2.9.1
163David Waern <david.waern@gmail.com>**20101219180649
164 Ignore-this: 24e440e93a68f24bc93d3906bf93c040
165]
166Patch bundle hash:
167f2a48921f00eece632c20c4d0d9bb8cf9d967972