Tweak documentation (mostly for dependentTestGroup)#467
Conversation
|
@martijnbastiaan @Raveline just a gentle reminder; I think you are the best positioned to review this documentation. |
martijnbastiaan
left a comment
martijnbastiaan
left a comment
There was a problem hiding this comment.
This looks good! Thanks for the effort.
| #endif | ||
|
|
||
| -- | @computeStatistics@ computes a summary 'Statistics' for | ||
| -- | @computeStatistics@ computes a summary t'Statistics' for |
There was a problem hiding this comment.
Ah, learned myself something new.
Yet the t qualifier is default, so not really needed here:
From: https://haskell-haddock.readthedocs.io/latest/markup.html#hyperlinking-and-re-exported-entities
Since values and types live in different namespaces in Haskell, it is possible for a reference such as 'X' to be ambiguous. In such a case, Haddock defaults to pointing to the type. The ambiguity can be overcome by explicitly specifying a namespace, by way of a v (for value) or t (for type) immediately before the link
But of course, does not hurt.
There was a problem hiding this comment.
I don't really know why but without t'...' cabal haddock keeps spamming warnings about "ambiguity", very annoyingly.
3 participants
Closes #443 and also fixes a bunch of Haddock warnings.
@martijnbastiaan @Raveline could you please review?