Skip to content
This repository has been archived by the owner on Aug 3, 2024. It is now read-only.

no documentation for re-exported renamed modules #225

Closed
ghc-mirror opened this issue May 8, 2014 · 4 comments
Closed

no documentation for re-exported renamed modules #225

ghc-mirror opened this issue May 8, 2014 · 4 comments
Assignees

Comments

@ghc-mirror
Copy link

Original reporter: claude@

With a deep module heirarchy and modules re-exporting many modules, I find this syntax much less verbose:

module Foo (module M) where
import Bar as M
import Baz as M

But haddock makes no useful documentation.

The verbose repetitive syntax works as expected with links to the re-exported modules:

module Foo
  ( module Bar
  , module Baz
  ) where
import Bar
import Baz

It would be very nice if haddock recognised module renaming and generated appropriate links to the re-exported modules - as it is now I'm going to have to go back to listing everything twice so that documentation is useable.

@ghc-mirror ghc-mirror self-assigned this May 8, 2014
@ghc-mirror
Copy link
Author

Original reporter: sol@

Smells like a bug. Thanks for reporting this!

@tfausak
Copy link

tfausak commented Jan 4, 2017

Duplicate of #121?

@ntc2
Copy link
Contributor

ntc2 commented May 7, 2017

Issue #584 also mentions this issue among others.

bgamari pushed a commit to bgamari/ghc that referenced this issue Sep 5, 2017
This is another take on https://phabricator.haskell.org/D3844.

This patch removes then need for haddock to reimplement the calculation
of exported names from modules. Instead when renaming export lists ghc
annotates each IE with its exported names.

Haddocks current  export logic has caused lots of trouble in the past
(on the Github issue tracker):
  - haskell/haddock#121
  - haskell/haddock#174
  - haskell/haddock#225
  - haskell/haddock#344
  - haskell/haddock#584
  - haskell/haddock#591
  - haskell/haddock#597

Reviewers: austin, bgamari, ezyang

Reviewed By: bgamari, ezyang

Subscribers: rwbarton, thomie

Differential Revision: https://phabricator.haskell.org/D3864
bgamari pushed a commit to bgamari/ghc that referenced this issue Sep 5, 2017
This is another take on https://phabricator.haskell.org/D3844.

This patch removes then need for haddock to reimplement the calculation
of exported names from modules. Instead when renaming export lists ghc
annotates each IE with its exported names.

Haddocks current  export logic has caused lots of trouble in the past
(on the Github issue tracker):
  - haskell/haddock#121
  - haskell/haddock#174
  - haskell/haddock#225
  - haskell/haddock#344
  - haskell/haddock#584
  - haskell/haddock#591
  - haskell/haddock#597

Reviewers: austin, bgamari, ezyang

Reviewed By: bgamari, ezyang

Subscribers: rwbarton, thomie

Differential Revision: https://phabricator.haskell.org/D3864
bgamari pushed a commit to bgamari/ghc that referenced this issue Sep 5, 2017
This is another take on https://phabricator.haskell.org/D3844.

This patch removes then need for haddock to reimplement the calculation
of exported names from modules. Instead when renaming export lists ghc
annotates each IE with its exported names.

Haddocks current  export logic has caused lots of trouble in the past
(on the Github issue tracker):
  - haskell/haddock#121
  - haskell/haddock#174
  - haskell/haddock#225
  - haskell/haddock#344
  - haskell/haddock#584
  - haskell/haddock#591
  - haskell/haddock#597

Reviewers: austin, bgamari, ezyang

Reviewed By: bgamari, ezyang

Subscribers: rwbarton, thomie

Differential Revision: https://phabricator.haskell.org/D3864
ghc-mirror pushed a commit to ghc/ghc that referenced this issue Sep 5, 2017
This is another take on https://phabricator.haskell.org/D3844.

This patch removes then need for haddock to reimplement the calculation
of exported names from modules. Instead when renaming export lists ghc
annotates each IE with its exported names.

Haddocks current  export logic has caused lots of trouble in the past
(on the Github issue tracker):
  - haskell/haddock#121
  - haskell/haddock#174
  - haskell/haddock#225
  - haskell/haddock#344
  - haskell/haddock#584
  - haskell/haddock#591
  - haskell/haddock#597

Updates haddock submodule.

Reviewers: austin, bgamari, ezyang

Reviewed By: bgamari, ezyang

Subscribers: rwbarton, thomie

Differential Revision: https://phabricator.haskell.org/D3864
@gbaz
Copy link
Contributor

gbaz commented Feb 5, 2018

should be resolved by #688

@gbaz gbaz closed this as completed Feb 5, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants