Ticket #5466 (new bug)

Opened 21 months ago

Last modified 18 months ago

Documentation for Chan could be better

Reported by: pumpkin Owned by:
Priority: normal Milestone: _|_
Component: libraries/base Version: 7.2.1
Keywords: Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Difficulty:
Test Case: Blocked By:
Blocking: Related Tickets:

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.

Change History

Changed 18 months ago by igloo

  • milestone set to _|_

For deprecated docs, ideally haddock would generate them from the pragmas.

Note: See TracTickets for help on using tickets.