[GHC] #14653: Text missing in ghc-prim's documentation

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
7 messages Options
Reply | Threaded
Open this post in threaded view
|

[GHC] #14653: Text missing in ghc-prim's documentation

GHC - devs mailing list
#14653: Text missing in ghc-prim's documentation
-------------------------------------+-------------------------------------
           Reporter:  gallais        |             Owner:  (none)
               Type:  bug            |            Status:  new
           Priority:  normal         |         Milestone:
          Component:  libraries      |           Version:  8.2.2
  (other)                            |
           Keywords:  ghc-prim       |  Operating System:  Unknown/Multiple
       Architecture:                 |   Type of failure:  Documentation
  Unknown/Multiple                   |  bug
          Test Case:                 |        Blocked By:
           Blocking:                 |   Related Tickets:
Differential Rev(s):                 |         Wiki Page:
-------------------------------------+-------------------------------------
 The comment for `reallyUnsafePtrEquality#` visible on
 [https://hackage.haskell.org/package/ghc-prim-0.5.1.1/docs/GHC-
 Prim.html#v:reallyUnsafePtrEquality-35- hackage] gives the impression that
 the function returns `1#` when the two points are not equal.

 Looking [https://hackage.haskell.org/package/ghc-
 prim-0.5.1.1/docs/src/GHC.Prim.html#reallyUnsafePtrEquality%23 at the
 source code], the intended comment is the complete opposite.

 It seems that haddock ate everything between hashes.

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14653>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler

_______________________________________________
ghc-tickets mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-tickets
Reply | Threaded
Open this post in threaded view
|

Re: [GHC] #14653: Text missing in ghc-prim's documentation

GHC - devs mailing list
#14653: Text missing in ghc-prim's documentation
-------------------------------------+-------------------------------------
        Reporter:  gallais           |                Owner:  (none)
            Type:  bug               |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  libraries         |              Version:  8.2.2
  (other)                            |
      Resolution:                    |             Keywords:  ghc-prim
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------
Description changed by gallais:

Old description:

> The comment for `reallyUnsafePtrEquality#` visible on
> [https://hackage.haskell.org/package/ghc-prim-0.5.1.1/docs/GHC-
> Prim.html#v:reallyUnsafePtrEquality-35- hackage] gives the impression
> that the function returns `1#` when the two points are not equal.
>
> Looking [https://hackage.haskell.org/package/ghc-
> prim-0.5.1.1/docs/src/GHC.Prim.html#reallyUnsafePtrEquality%23 at the
> source code], the intended comment is the complete opposite.
>
> It seems that haddock ate everything between hashes.
New description:

 The comment for `reallyUnsafePtrEquality#` visible on
 [https://hackage.haskell.org/package/ghc-prim-0.5.1.1/docs/GHC-
 Prim.html#v:reallyUnsafePtrEquality-35- hackage] gives the impression that
 the function returns `1#` when the two pointers are not equal.

 Looking [https://hackage.haskell.org/package/ghc-
 prim-0.5.1.1/docs/src/GHC.Prim.html#reallyUnsafePtrEquality%23 at the
 source code], the intended comment is the complete opposite.

 It seems that haddock ate everything between hashes.

--

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14653#comment:1>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler

_______________________________________________
ghc-tickets mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-tickets
Reply | Threaded
Open this post in threaded view
|

Re: [GHC] #14653: Text missing in ghc-prim's documentation

GHC - devs mailing list
In reply to this post by GHC - devs mailing list
#14653: Text missing in ghc-prim's documentation
-------------------------------------+-------------------------------------
        Reporter:  gallais           |                Owner:  (none)
            Type:  bug               |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  libraries         |              Version:  8.2.2
  (other)                            |             Keywords:  ghc-prim,
      Resolution:                    |  newcomer
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------
Changes (by RyanGlScott):

 * keywords:  ghc-prim => ghc-prim, newcomer


--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14653#comment:2>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler

_______________________________________________
ghc-tickets mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-tickets
Reply | Threaded
Open this post in threaded view
|

Re: [GHC] #14653: Text missing in ghc-prim's documentation

GHC - devs mailing list
In reply to this post by GHC - devs mailing list
#14653: Text missing in ghc-prim's documentation
-------------------------------------+-------------------------------------
        Reporter:  gallais           |                Owner:  sighingnow
            Type:  bug               |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  libraries         |              Version:  8.2.2
  (other)                            |             Keywords:  ghc-prim,
      Resolution:                    |  newcomer
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):  Phab:D4305
       Wiki Page:                    |
-------------------------------------+-------------------------------------
Changes (by sighingnow):

 * owner:  (none) => sighingnow
 * differential:   => Phab:D4305


--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14653#comment:3>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler

_______________________________________________
ghc-tickets mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-tickets
Reply | Threaded
Open this post in threaded view
|

Re: [GHC] #14653: Text missing in ghc-prim's documentation

GHC - devs mailing list
In reply to this post by GHC - devs mailing list
#14653: Text missing in ghc-prim's documentation
-------------------------------------+-------------------------------------
        Reporter:  gallais           |                Owner:  sighingnow
            Type:  bug               |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  libraries         |              Version:  8.2.2
  (other)                            |             Keywords:  ghc-prim,
      Resolution:                    |  newcomer
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):  Phab:D4305
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by Ben Gamari <ben@…>):

 In [changeset:"2feed118413944cae8a4eed17365f40521f470db/ghc" 2feed11/ghc]:
 {{{
 #!CommitTicketReference repository="ghc"
 revision="2feed118413944cae8a4eed17365f40521f470db"
 Fix hash in haddock of ghc-prim.

 Reviewers: bgamari

 Reviewed By: bgamari

 Subscribers: rwbarton, thomie, carter

 GHC Trac Issues: #14653

 Differential Revision: https://phabricator.haskell.org/D4305
 }}}

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14653#comment:4>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler

_______________________________________________
ghc-tickets mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-tickets
Reply | Threaded
Open this post in threaded view
|

Re: [GHC] #14653: Text missing in ghc-prim's documentation

GHC - devs mailing list
In reply to this post by GHC - devs mailing list
#14653: Text missing in ghc-prim's documentation
-------------------------------------+-------------------------------------
        Reporter:  gallais           |                Owner:  sighingnow
            Type:  bug               |               Status:  merge
        Priority:  normal            |            Milestone:  8.4.1
       Component:  libraries         |              Version:  8.2.2
  (other)                            |             Keywords:  ghc-prim,
      Resolution:                    |  newcomer
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):  Phab:D4305
       Wiki Page:                    |
-------------------------------------+-------------------------------------
Changes (by bgamari):

 * status:  new => merge
 * milestone:   => 8.4.1


--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14653#comment:5>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler

_______________________________________________
ghc-tickets mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-tickets
Reply | Threaded
Open this post in threaded view
|

Re: [GHC] #14653: Text missing in ghc-prim's documentation

GHC - devs mailing list
In reply to this post by GHC - devs mailing list
#14653: Text missing in ghc-prim's documentation
-------------------------------------+-------------------------------------
        Reporter:  gallais           |                Owner:  sighingnow
            Type:  bug               |               Status:  closed
        Priority:  normal            |            Milestone:  8.4.1
       Component:  libraries         |              Version:  8.2.2
  (other)                            |             Keywords:  ghc-prim,
      Resolution:  fixed             |  newcomer
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):  Phab:D4305
       Wiki Page:                    |
-------------------------------------+-------------------------------------
Changes (by bgamari):

 * status:  merge => closed
 * resolution:   => fixed


Comment:

 Merged in f28645c04958a2e2ab61239db70478d9dcce6ba6.

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/14653#comment:6>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler

_______________________________________________
ghc-tickets mailing list
[hidden email]
http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-tickets