Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken -+-- Reporter: japple|Owner: Type: bug | Status: closed Priority: high |Milestone: 6.12.1 Component: Documentation | Version: 6.11 Severity: normal| Resolution: fixed Keywords:| Difficulty: Unknown Testcase:| Os: Unknown/Multiple Architecture: Unknown/Multiple | -+-- Changes (by simonmar): * status: new = closed * resolution: = fixed Comment: Now fixed, mainly thanks to isaacdupree's SoC patches, and also thanks to David's subsequent fixes. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:25 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken -+-- Reporter: japple|Owner: Type: bug | Status: new Priority: high |Milestone: 6.12.1 Component: Documentation | Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Os: Unknown/Multiple Architecture: Unknown/Multiple | -+-- Comment (by isaacdupree): So, this should be fixed with Haddock HEAD, as soon as we decide it's stable enough to release... not for a few days at least :-), but pretty surely before the GHC RC -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:24 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken -+-- Reporter: japple|Owner: Type: bug | Status: new Priority: high |Milestone: 6.12.1 Component: Documentation | Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Os: Unknown/Multiple Architecture: Unknown/Multiple | -+-- Changes (by igloo): * milestone: 6.12 branch = 6.12.1 -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:23 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken -+-- Reporter: japple|Owner: Type: bug | Status: new Priority: high |Milestone: 6.12 branch Component: Documentation | Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Os: Unknown/Multiple Architecture: Unknown/Multiple | -+-- Comment (by simonmar): Replying to [comment:21 waern]: Re-exported names now appear in the documentation for Data.Array (#2746 fixed). However, there are no links to the original module GHC.Arr since it is hidden (in the Haddock sense of the word). So while waiting for Haddock to fully document re-exports from other packages, we could perhaps un-hide this module or export the declarations from another non-hidden module in base. `GHC.Arr` is not hidden in the GHC 6.10 branch, as a workaround for exactly this. Maybe we should un-hide it in the HEAD too, with a comment to explain why, to avoid future confusion. BTW David - thanks for all your work on fixing Haddock recently, it's much appreciated! -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:22 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken -+-- Reporter: japple|Owner: Type: bug | Status: new Priority: high |Milestone: 6.12 branch Component: Documentation | Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Os: Unknown/Multiple Architecture: Unknown/Multiple | -+-- Comment (by waern): Re-exported names now appear in the documentation for Data.Array (#2746 fixed). However, there are no links to the original module GHC.Arr since it is hidden (in the Haddock sense of the word). So while waiting for Haddock to fully document re-exports from other packages, we could perhaps un-hide this module or export the declarations from another non-hidden module in base. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:21 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken --+- Reporter: japple| Owner: Type: bug | Status: new Priority: high | Milestone: 6.12 branch Component: Documentation |Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Architecture: Unknown/Multiple Os: Unknown/Multiple | --+- Changes (by igloo): * owner: igloo = -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:20 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken
--+-
Reporter: japple| Owner: igloo
Type: bug | Status: new
Priority: high | Milestone: 6.12 branch
Component: Documentation |Version: 6.11
Severity: normal| Resolution:
Keywords:| Difficulty: Unknown
Testcase:| Architecture: Unknown/Multiple
Os: Unknown/Multiple |
--+-
Comment (by simonmar):
That Haddock bug only applies to references to modules from inside
documentation, so the hyperlinks for the actual names should still work,
right? Also, could we do something like this:
{{{
module Data.Array where
import qualified GHC.Arr
-- | .. documentation for 'array'
array = GHC.Arr.array
}}}
only works for functions, of course.
--
Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:18
GHC http://www.haskell.org/ghc/
The Glasgow Haskell Compiler___
Glasgow-haskell-bugs mailing list
Glasgow-haskell-bugs@haskell.org
http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken
--+-
Reporter: japple| Owner: igloo
Type: bug | Status: new
Priority: high | Milestone: 6.12 branch
Component: Documentation |Version: 6.11
Severity: normal| Resolution:
Keywords:| Difficulty: Unknown
Testcase:| Architecture: Unknown/Multiple
Os: Unknown/Multiple |
--+-
Comment (by igloo):
Replying to [comment:18 simonmar]:
That Haddock bug only applies to references to modules from inside
documentation, so the hyperlinks for the actual names should still work,
right?
Yes. I was trying to say Look in GHC.Arr for docs.
Also, could we do something like this:
{{{
module Data.Array where
import qualified GHC.Arr
-- | .. documentation for 'array'
array = GHC.Arr.array
}}}
only works for functions, of course.
Also, if GHC.Arr.array and Data.Array.array are both in scope then you
have an ambiguous variable.
But links to array in the docs go to GHC.Arr now, so it's only people
browsing to the Data.Array docs who will have the inconvenience of having
to manually browse to the GHC.Arr docs.
It's not a perfect situation, but I think it's good enough for now.
--
Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:19
GHC http://www.haskell.org/ghc/
The Glasgow Haskell Compiler___
Glasgow-haskell-bugs mailing list
Glasgow-haskell-bugs@haskell.org
http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken --+- Reporter: japple| Owner: igloo Type: bug | Status: new Priority: high | Milestone: 6.12 branch Component: Documentation |Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Architecture: Unknown/Multiple Os: Unknown/Multiple | --+- Changes (by igloo): * milestone: 6.10.1 = 6.12 branch Comment: Hmm, not so simple. I've just unhidden GHC.Arr in the 6.10 branch. Unfortunately, we can't link there from Data.Array due to http://trac.haskell.org/haddock/ticket/13 -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:17 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken --+- Reporter: japple| Owner: igloo Type: bug | Status: new Priority: high | Milestone: 6.10.1 Component: Documentation |Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Architecture: Unknown/Multiple Os: Unknown/Multiple | --+- Changes (by igloo): * status: reopened = new * owner: = igloo Comment: I'll fix this with copy/paste in the 6.10 branch. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:16 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken --+- Reporter: japple| Owner: Type: bug | Status: reopened Priority: high | Milestone: 6.10.1 Component: Documentation |Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Architecture: Unknown/Multiple Os: Unknown/Multiple | --+- Changes (by simonmar): * priority: normal = high -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:15 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken --+- Reporter: japple| Owner: Type: bug | Status: reopened Priority: normal| Milestone: 6.10.1 Component: Documentation |Version: 6.11 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Architecture: Unknown/Multiple Os: Unknown/Multiple | --+- Changes (by waern): * cc: [EMAIL PROTECTED] (added) * version: 6.8.3 = 6.11 -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:14 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken --+- Reporter: japple| Owner: Type: bug | Status: reopened Priority: normal| Milestone: 6.10.1 Component: Documentation |Version: 6.8.3 Severity: normal| Resolution: Keywords:| Difficulty: Unknown Testcase:| Architecture: Unknown/Multiple Os: Unknown/Multiple | --+- Comment (by waern): We should make Haddock document re-exports from other packages properly. For this to work, GHC needs to provide `Binary` instances for `LHsDecl` and the types it contains. It would also be nice if it provided instances for `HsDoc` and `HaddockModInfo` which Haddock currently defines itself. We need the `Binary` instances so we can store the declarations and doc comments in the .haddock files. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:13 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: reopened Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.3 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by simonmar): A quick fix for 6.10.1 would be to un-hide `GHC.Arr`, then at least we'd get hyperlinks in the `Data.Array` docs that would take you to the actual documentation. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:10 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: reopened Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.3 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Changes (by japple): * status: closed = reopened * version: 6.8.2 = 6.8.3 * resolution: invalid = Comment: We should not wait for Haddock to be fixed to get this fixed. If Haddock can't generate the proper documentation for symbols exported from another package, the GHC documentation should be generated from the appropriate package. If the main repository for documentation of the standard library does not document how arrays are used, I would venture to say that your language does not really support arrays. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:8 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: reopened Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.3 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by japple): I mean one's language, not your language. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:9 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: closed Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.2 Severity: normal | Resolution: invalid Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Changes (by igloo): * status: new = closed * resolution: = invalid Comment: This is http://trac.haskell.org/haddock/ticket/24 -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:7 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.2 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by igloo): See also #1269 -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.2 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by japple): Haddock 2 will fix this, as I understand it. Actually, it seems even worse. See http://code.haskell.org/~fons/libraries .html-haddock2.tgz, found at ticket:2299. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.2 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by ross): We really need a bug tracker for Haddock2. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.2 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Changes (by igloo): * owner: igloo = Comment: I think that the problem is that haddock would be able to see the docs (which live in `base:GHC.Arr`) when compiling `base:Data.Array`, but now that it compiles `array:Data.Array` it can no longer see them. We should fix this somehow if possible; one way might be to just move `GHC.Array` into the `array` package; I don't know how feasible that is. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.2 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by simonmar): Haddock 2 will fix this, as I understand it. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #2337: Data.Array documentation utterly broken
#2337: Data.Array documentation utterly broken ---+ Reporter: japple | Owner: igloo Type: bug| Status: new Priority: normal | Milestone: 6.10.1 Component: Documentation |Version: 6.8.2 Severity: normal | Resolution: Keywords: | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Changes (by igloo): * owner: = igloo * difficulty: = Unknown * milestone: = 6.10.1 Comment: Thanks for the heads-up, we'll look into what's going on. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/2337#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
