on master help sign in
Add note on Effects to ST tutorial
commitef3c9d7ca0ce38d2921865b3e5ecd642504e7eaf authorEdwin Brady <ecb10@st-andrews.ac.uk> dateFri 24 Mar 2017, 18:54 (10 years ago) parent5bdfc89
1 file changed+12
docs/effects/index.rst+12
docs/effects/index.rst+12
@@ -6,6 +6,18 @@ The Effects Tutorial
66
77A tutorial on the `Effects` package in `Idris`.
88
9+.. topic:: Effects and the ``Control.ST`` module
10+
11+ There is a new module in the ``contrib`` package, ``Control.ST``, which
12+ provides the resource tracking facilities of `Effects` but with
13+ better support for creating and deleting resources, and implementing
14+ resources in terms of other resources.
15+
16+ Unless you have a particular reason to use `Effects` you are strongly
17+ recommended to use ``Control.ST`` instead. There is a tutorial available
18+ on this site for ``Control.ST`` with several examples
19+ (:ref:`st-tutorial-index`).
20+
921.. note::
1022
1123 The documentation for Idris has been published under the Creative