事实证明,Haddock不会为类型类方法呈现每个参数的文档:
class Foo a where
foo
:: Int -- ^ This string will be ignored by Haddock
-> a
这给我维护的库的用户带来了某些问题,因为在我的情况下,这些方法的签名很长。我一直在源代码中使用这种格式的描述(一定适用于普通函数),但事实证明,Haddock不会显示它们(也不会抱怨它们)。
有没有办法用Haddock显示每个参数的文档?可能有一些解决方法?
好的,这是回归。这个东西应该可以工作(并在2.16.1版本中可以工作),但是可以停止工作(2.17.1和更高版本)。
我已经报告了这个问题:https : //github.com/haskell/haddock/issues/647,应该在2.18版本中修复(您可以看到已经有PR了)。
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句