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

[GHC]

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

 * cc: core-libraries-committee@… (added)
 * difficulty:   => Unknown


Old description:

> The summary is two words, and none of the operations say whether they
> block or not. Someone on reddit was expecting a read to throw an
> exception if the Chan was empty, for example. It also turns out that
> isEmptyChan is deprecated, but the documentation doesn't mention it.

New description:

 The summary is two words, and none of the operations say whether they
 block or not. Someone on reddit was expecting a read to throw an exception
 if the Chan was empty, for example.

--

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