Ticket #179 (new enhancement)
Reusing named chunks in other modules
| Reported by: | reinerp | Owned by: | |
|---|---|---|---|
| Priority: | minor | Milestone: | |
| Version: | 2.9.2 | Keywords: | |
| Cc: |
Description
Similar to #97. Consider the following:
module A ( -- $note f, ) where -- $note -- This is a long note. -- | This is a function f :: Int -> Int f x = x module B ( -- $A.note f, ) where import A
Currently, there is no way to insert the documentation chunk named $note (which is defined in module A) into the documentation for B. I propose the above syntax as a way to do this.
The motivation for this construct is as follows. Since A and B export (at least some of) the same API, the $note chunk should be included in both of their Haddocks. It is possible to work around this need by using anchors to link to A's note from B, but this a workaround rather than a solution.
Change History
Note: See
TracTickets for help on using
tickets.
