Examples.hs

{-# OPTIONS_GHC -Wall #-}

{- | Example ReOC applications of made-up operators, each filled in field by
field from 'ReOC.Model.mkUnfilledReOC' and checked by 'ReOC.Fill.fillReOC',
with the name of the directory of @examples@ that holds its documents; and a
draft that is not yet complete.
-}
module ReOC.Examples (
  examples,
  module ReOC.Example.BanksiaPoint,
  module ReOC.Example.Draft,
  module ReOC.Example.Ironbark,
  module ReOC.Example.Saltbush,
  module ReOC.Example.WattleCreek,
) where

import Data.List.NonEmpty (NonEmpty)
import ReOC.Example.BanksiaPoint
import ReOC.Example.Draft
import ReOC.Example.Ironbark
import ReOC.Example.Saltbush
import ReOC.Example.WattleCreek
import ReOC.Model (ReOC, ReOCError)

-- | Each complete example, with the name of its directory: valid, or every reason it is not.
examples :: [(FilePath, Either (NonEmpty ReOCError) ReOC)]
examples =
  [ ("banksia-point-aerial-media", banksiaPoint)
  , ("ironbark-asset-inspection", ironbark)
  , ("saltbush-ag-surveys", saltbush)
  , ("wattle-creek-drone-academy", wattleCreek)
  ]