License	BSD-3-Clause
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.Doc.Pedagogy

Description

Assess pedagogical soundness of the tutorials.

Approach:

Obtain a list of all of the tutorial scenarios, in order
Search their "solution" code for commands
"fold" over the tutorial list, noting which tutorial was first to introduce each command

Synopsis

renderTutorialProgression :: IO Text
generateIntroductionsSequence :: ScenarioCollection -> [CoverageInfo]
data CoverageInfo = CoverageInfo {
- tutInfo :: TutorialInfo
- novelSolutionCommands :: Map Const [SrcLoc]
}
data TutorialInfo = TutorialInfo {
- scenarioPair :: ScenarioInfoPair
- tutIndex :: Int
- solutionCommands :: Map Const [SrcLoc]
- descriptionCommands :: Set Const
}

Documentation

renderTutorialProgression :: IO Text Source #

Generate a document which lists all the tutorial scenarios, highlighting for each one which commands are introduced for the first time in the canonical solution, and which commands are referenced in the tutorial description.

generateIntroductionsSequence :: ScenarioCollection -> [CoverageInfo] Source #

Extract the tutorials from the complete scenario collection and derive their command coverage info.

data CoverageInfo Source #

Tutorials augmented by the set of commands that they introduce. Generated by folding over all of the tutorials in sequence.

Constructors

CoverageInfo
Fields tutInfo :: TutorialInfo novelSolutionCommands :: Map Const [SrcLoc]

data TutorialInfo Source #

Tutorial scenarios with the set of commands introduced in their solution and descriptions having been extracted

Constructors

TutorialInfo
Fields scenarioPair :: ScenarioInfoPair tutIndex :: Int solutionCommands :: Map Const [SrcLoc] descriptionCommands :: Set Const