[PATCH] Haddockify some comments in compiler/hsSyn/HsBinds.lhs
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 I have turned some comments in compiler/hsSyn/HsBinds.lhs into Haddock format. They were just sitting there, hidden from the world (to spite anyone scratching their heads when looking through the generated docs, like myself). They were already written so why not use them? See attachment. I trust that they're right but I cannot guarantee it. - -- Mateusz K. -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.19 (GNU/Linux) iQIcBAEBAgAGBQJRsQ3TAAoJEM1mucMq2pqX9lQP/Al86/rfrr+Q6yLf8HtudIeT +vBDu/r4wClZmNzKKxrtgECELl5UoRX33EUdY2ydHAh0VyPFQZwK1G2Xzktg6zjS 8DSvPhHWDvlces3EWdQOyScwMG+jm+/ezdhU7LVQjCEPvfSQ21csIrDkdRgGH918 qD6wThZ7lZMfccJkkFxya8MIN9XJxQCW65XGUobVgpY5OyQTmy5Dj5teYz+GW/7O VWUUDyNQP6OtlmefhdvHEjrq88Gl+YylAa6x4B27mavRxmdV2gzMxcApfcwj5vkD 1T8+Azl8zpAOwOLa02is7yb0gsuIo/naropcicSeyz67S+Bivp/XO/Z66n6BEAhW iIr+fCTJeArU2NZ5erT/Awkcw9yam8hD3/3wJgaME07Q6Qmfd0l1NoXm4u/6M/Hr yLFhinnRBe/NiENf9wxWzSCky/lkvZjmWcchxPYFN1ZtmOKnP07S1YnjKZ+XEwwW X72XIMAbKzUkhm615UkV//Z09ueTEXpHvA7JRiCVpCivpHX8mXWwe5Su5tlrvL6t /DO2uUawD9OcPpSgarqI1/j+JmWmDq0/ayGI2Wj5PQmp5gFZS8EfYANYXDOCa4nx bZh32ZIgh+agoMvo/XqhRdO0oj/rTd9V3mrh3Na1Yu0KcC3uRwkiBfj0S0C/Wb92 bjxukm7b56XtazyUk2BX =0okt -----END PGP SIGNATURE-----
Hi Mateusz, On Thu, Jun 06, 2013 at 11:31:47PM +0100, Mateusz Kowalczyk wrote:
I have turned some comments in compiler/hsSyn/HsBinds.lhs into Haddock format. They were just sitting there, hidden from the world (to spite anyone scratching their heads when looking through the generated docs, like myself). They were already written so why not use them?
I agree, they may as well be haddock comments. However, I tried applying your patch, and the build failed with errors like: compiler/hsSyn/HsBinds.lhs:56:32: parse error on input `-- ^ Bindings in a 'let' expression -- or a 'where' clause' doc comment parse failed: If @co :: T ts ~ rep_ty@ then: Thanks Ian -- Ian Lynagh, Haskell Consultant Well-Typed LLP, http://www.well-typed.com/
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On 13/07/13 16:26, Ian Lynagh wrote:
Hi Mateusz,
On Thu, Jun 06, 2013 at 11:31:47PM +0100, Mateusz Kowalczyk wrote:
I have turned some comments in compiler/hsSyn/HsBinds.lhs into Haddock format. They were just sitting there, hidden from the world (to spite anyone scratching their heads when looking through the generated docs, like myself). They were already written so why not use them?
I agree, they may as well be haddock comments. However, I tried applying your patch, and the build failed with errors like:
compiler/hsSyn/HsBinds.lhs:56:32: parse error on input `-- ^ Bindings in a 'let' expression -- or a 'where' clause'
doc comment parse failed: If @co :: T ts ~ rep_ty@ then:
Thanks Ian
I'll fix it up and get back to you when I can confirm that GHC will actually build with the patch. Sorry! - -- Mateusz K. -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.20 (GNU/Linux) iQIcBAEBAgAGBQJR4XOmAAoJEM1mucMq2pqXHLEP/21TIbRWt8un4Gsd9c9H5jhS tV5OIobrRc4t11EXowpQNxepblQMJZSB+y/4eQy28ztjs+WffxfRtw0OORwsVJV7 unFDXWuucD9cZXCSSsbaGQPSlXA0XncdJOwGJm3Vilz/FzBisX4Bzj6ZO8fBMHo7 4/wlaylSg4LNDVmlyeAueTiYHi4WvrIDlEpghe0rPUYNXvMk9AY2cE6PAI+9KOcq aNPiibxEwQ4T3TnM3mGCBlIgFkADS6eiUANtm4iI+9C8a2uK1QABM43d4a5YKl6u LD9m0VMDvz8zHakX6/eIoYGYe9zIoVTTBC3l8FHsVHss9bXp9LUyl4eWa/oai7qP KdqZFGHn171qnwHZYs2oF9oBrkJ+g2ylEBXPfS8wjjzuiqDDHHmQd8kXAzb60UQv 14VpEyL4cHKL3FC9ckI3mRB5uOVaz7C86qcewnORZhbcyi0g6usAYWCedoblS6kf BH1VSatToIGxuv3CBQFIvrZ3ElqIAgE83d0TKLbCSZ2Dv8PGyuJewCxvDVSArl6i RYkq6jlAOBj4fXU6rdktz6j8rIDF09efNmjsS87O/A66K9KkPoJGqjlnUE/PS6JM DoP2VqbnClQE+Q8sQ8OMiMdX1AEJvM/zMTQhES2xAL/zLSPBQOBVPeN1EfoeaKSH +t77d3p1Wu/PiaI/YRHP =YIM+ -----END PGP SIGNATURE-----
participants (2)
-
Ian Lynagh -
Mateusz Kowalczyk