[GHC] #5466: Documentation for Chan could be better

[GHC]

#5466: Documentation for Chan could be better
-------------------------------------+-------------------------------------
        Reporter:  pumpkin           |                Owner:  (none)
            Type:  bug               |               Status:  new
        Priority:  normal            |            Milestone:  ⊥
       Component:  Core Libraries    |              Version:  7.2.1
      Resolution:                    |             Keywords:
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by Ömer Sinan Ağacan <omeragacan@…>):

 In [changeset:"42ef0845d0d2a7cc524e7048502f651d66f6a543/ghc"
 42ef0845/ghc]:
 {{{
 #!CommitTicketReference repository="ghc"
 revision="42ef0845d0d2a7cc524e7048502f651d66f6a543"
 Improve `readChan` documentation:

 - Mention that the read end is an `MVar`, so fairness guarantees are
   inherited.

 - Mention that it can throw `BlockedIndefinitelyOnMVar` exception.

 Reviewers: austin, hvr, bgamari

 Reviewed By: bgamari

 Subscribers: rwbarton, thomie

 GHC Trac Issues: #5466

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

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