Merge branch 'develop-no-orphans' into develop. Close #284.

dunai/CHANGELOG

@@ -1,7 +1,8 @@
 2022-05-07 Ivan Perez <ivan.perez@keera.co.uk>
         * src/: Simplify implementation of swtich (#276), remove redundant
           imports (#281), remove redundant pragma (#282), use external
-          Void type (#79), remove redundant imports (#283).
+          Void type (#79), remove redundant imports (#283), disable warning
+          pertaining to orphan instances (#284).
 
 2022-04-21 Ivan Perez <ivan.perez@keera.co.uk>
         * dunai.cabal: Version bump (0.8.2) (#280), syntax rules (#271),

dunai/src/Data/MonadicStreamFunction/Core.hs

@@ -1,4 +1,9 @@
 {-# LANGUAGE Rank2Types #-}
+-- We disable the following warning because this module purposefully defines
+-- orphan instances. This is a design decision in Dunai, so that we give
+-- implementors further flexibility while giving most users the features they
+-- expect.
+{-# OPTIONS_GHC -fno-warn-orphans #-}
 -- |
 -- Copyright  : (c) Ivan Perez and Manuel Baerenz, 2016
 -- License    : BSD3

dunai/src/Data/MonadicStreamFunction/InternalCore.hs

@@ -15,9 +15,13 @@
 -- 'MSF's are a generalisation of the implementation mechanism used by Yampa,
 -- Wormholes and other FRP and reactive implementations.
 --
--- This modules defines only the minimal core. Hopefully, other functions can
--- be defined in terms of the functions in this module without accessing the
--- MSF constuctor.
+-- This modules defines only the minimal core. By default, you should import
+-- "Data.MonadicStreamFunction.Core" or "Data.MonadicStreamFunction" whenever
+-- possible, and define your functions without accessing the MSF constuctor.
+-- Those modules, as well as other modules in dunai, also provide convenient
+-- instances. This module may be useful if you are extending dunai with
+-- functionality that cannot be (conveniently) expressed using the existing
+-- high-level API.
 
 
 -- NOTE TO IMPLEMENTORS: