[Haddock] [haddock] #254: Unexported things are shown as exported
haddock
haddock at projects.haskell.org
Sat Aug 31 20:54:58 BST 2013
#254: Unexported things are shown as exported
-------------------------+--------------------------------------------------
Reporter: NeilMitchell | Owner:
Type: defect | Status: new
Priority: major | Milestone:
Version: 2.12.0 | Resolution:
Keywords: |
-------------------------+--------------------------------------------------
Comment(by waern):
I'm working on a fix.
I'm also trying to fix the where M1 has an explicit export list with
section headers and/or loose doc comments. Do you have an opinion on what
should happen in that case? Should they appear in M2's documentation?
Perhaps one wouldn't write such hidden modules but the issue also comes up
when "partially" (like this) re-exporting non-hidden modules.
Both loose doc comments and section headers could potentially refer to
things which are not re-exported, so they may become nonsensical when
placed in the outer module. However one could probably quite reasonably
say that section headers could be included if the resulting section in the
outer module becomes is non-empty. Loose doc comments I think it's best to
filter out.
--
Ticket URL: <http://trac.haskell.org/haddock/ticket/254#comment:2>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool
More information about the Haddock
mailing list