Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Defines functions used in creating an introduction section.
Synopsis
- orgSec :: NamedIdea c => c -> Section -> Sentence -> Section
- introductionSection :: Sentence -> Sentence -> [Section] -> Section
- purposeOfDoc :: [Sentence] -> Section
- scopeOfRequirements :: Sentence -> Section
- charIntRdrF :: Idea a => a -> [Sentence] -> [Sentence] -> [Sentence] -> Section -> Section
- purpDoc :: CI -> Verbosity -> [Sentence]
Documentation
purposeOfDoc :: [Sentence] -> Section Source #
Constructor for Purpose of Document subsection. Takes a list of Sentence
s that:
- Given one element: explains the purpose of the specific example.
- Given two elements: explains the purpose of the specific example and the development process.
- Otherwise: Uses the default
developmentProcessParagraph
.
scopeOfRequirements :: Sentence -> Section Source #
Constructor for the Scope of Requirements subsection. Takes in the main requirement for the program.