[GHC] #13827: "What AbsBinds means" is a pretty confusing doc comment
#13827: "What AbsBinds means" is a pretty confusing doc comment -------------------------------------+------------------------------------- Reporter: literon | Owner: (none) Type: bug | Status: new Priority: normal | Milestone: Component: Documentation | Version: 8.0.1 Keywords: | Operating System: Unknown/Multiple Architecture: | Type of failure: None/Unknown Unknown/Multiple | Test Case: | Blocked By: Blocking: | Related Tickets: Differential Rev(s): | Wiki Page: -------------------------------------+------------------------------------- See the note in https://downloads.haskell.org/~ghc/8.0.1/docs/html/libraries/ghc-8.0.1/src/H... named "What AbsBinds means". It seems like the example refers variables that are not defined (at least in the example), for example `gp`. Also, a bit more verbose text would be welcome (aka I have no idea what is going on). Thank you! -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/13827 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#13827: "What AbsBinds means" is a pretty confusing doc comment -------------------------------------+------------------------------------- Reporter: literon | Owner: (none) Type: bug | Status: new Priority: normal | Milestone: Component: Documentation | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by bgamari): Have you seen `Note [AbsBinds]` also in that note? It might help clear things up a bit. That being said, I agree that `Note [What AbsBinds means]` is quite terse. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/13827#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#13827: "What AbsBinds means" is a pretty confusing doc comment -------------------------------------+------------------------------------- Reporter: literon | Owner: (none) Type: bug | Status: new Priority: normal | Milestone: Component: Documentation | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by literon): Thank you, those notes are much more informative. I wonder why the "what AbsBinds means" note got separated from those? Having read the former at least gives some impression about the latter, but there's still too many black spots (BIND, DBIND, seemingly still hanging references to vars). -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/13827#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#13827: "What AbsBinds means" is a pretty confusing doc comment -------------------------------------+------------------------------------- Reporter: literon | Owner: (none) Type: bug | Status: patch Priority: normal | Milestone: Component: Documentation | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3659 Wiki Page: | -------------------------------------+------------------------------------- Changes (by hsyl20): * status: new => patch * differential: => Phab:D3659 Comment: I have tried to infer what was meant (see Phab:D3659). -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/13827#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#13827: "What AbsBinds means" is a pretty confusing doc comment -------------------------------------+------------------------------------- Reporter: literon | Owner: (none) Type: bug | Status: patch Priority: normal | Milestone: Component: Documentation | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3659 Wiki Page: | -------------------------------------+------------------------------------- Comment (by simonpj): Close, thank you.... I wrote up a a better comment on the plane, and will commit when I have a decent internet connection -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/13827#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#13827: "What AbsBinds means" is a pretty confusing doc comment
-------------------------------------+-------------------------------------
Reporter: literon | Owner: (none)
Type: bug | Status: patch
Priority: normal | Milestone:
Component: Documentation | Version: 8.0.1
Resolution: | Keywords:
Operating System: Unknown/Multiple | Architecture:
| Unknown/Multiple
Type of failure: None/Unknown | Test Case:
Blocked By: | Blocking:
Related Tickets: | Differential Rev(s): Phab:D3659
Wiki Page: |
-------------------------------------+-------------------------------------
Comment (by Simon Peyton Jones
#13827: "What AbsBinds means" is a pretty confusing doc comment -------------------------------------+------------------------------------- Reporter: literon | Owner: (none) Type: bug | Status: patch Priority: normal | Milestone: Component: Documentation | Version: 8.0.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3659 Wiki Page: | -------------------------------------+------------------------------------- Comment (by literon): Looks great, thank you! -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/13827#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#13827: "What AbsBinds means" is a pretty confusing doc comment -------------------------------------+------------------------------------- Reporter: literon | Owner: (none) Type: bug | Status: closed Priority: normal | Milestone: 8.2.1 Component: Documentation | Version: 8.0.1 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Phab:D3659 Wiki Page: | -------------------------------------+------------------------------------- Changes (by bgamari): * status: patch => closed * resolution: => fixed * milestone: => 8.2.1 -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/13827#comment:7 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC