#7182 closed feature request (fixed)

Control.Monad.ST module description should reference Data.STRef

Reported by: guest Owned by:
Priority: normal Milestone: 7.8.1
Component: Compiler Version: 7.4.2
Keywords: Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Difficulty: Unknown
Test Case: Blocked By:
Blocking: Related Tickets:

Description

The description of "Control.Monad.ST" should mention the highly related module "Data.STRef" somewhere, preferably so that a clickable link is generated in the HTML library documentation.

1 or 2 years ago, I was looking for a simple state monad, and found "Control.Monad.ST", but did not understand it all. Googling around, I found and used "Control.Monad.State" from the MTL-library instead.

Now I accidentally found "Data.STRef", and immediately understood how I could use "Control.Monad.ST". It works fine and it is easier to use for very simple states - especially since it is part of the standard library. A simple reference to "Data.STRef" would have clearified it immediately for me - and probably for others too.

Change History (1)

comment:1 Changed 19 months ago by simonmar

  • Difficulty set to Unknown
  • Milestone set to 7.8.1
  • Resolution set to fixed
  • Status changed from new to closed

Fixed:

commit 2f07853609821b3cf916becb402f2fb78765daa4
Author: Simon Marlow <marlowsd@gmail.com>
Date:   Fri Aug 24 10:55:26 2012 +0100

    add pointers to Data.STRef and Data.Array.ST (#7182)
Note: See TracTickets for help on using tickets.