Skip to content

Commit

Permalink
Updated README to reflect previous changes; #918
Browse files Browse the repository at this point in the history
  • Loading branch information
samm82 committed May 1, 2019
1 parent 96888d9 commit a59c59e
Showing 1 changed file with 7 additions and 34 deletions.
41 changes: 7 additions & 34 deletions code/drasil-lang/Language/Drasil/Chunk/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,10 @@
----------------------------------------------------------
### Quick Summary of Folder Structure and File Contents
Last updated: July 19, 2018
Last updated: May 1, 2019
----------------------------------------------------------

**Concept**
- DefnAndDomain ConceptChunk, CommonConcept, and ConceptInstance data types

**Constrained**
- Defines Constraint type

AssumpChunk.hs
- Assumption Chunks *TODO: Move from drasil-lang to drasil-docLang*

Attribute.hs
- Helper functions for Attributes (Derivation, ShortName, SourceRef)

Change.hs
- Likely and Unlikely Change chunks *TODO: Move from drasil-lang to drasil-docLang*
- ConceptChunk, CommonConcept, and ConceptInstance data types

Citation.hs
- Citation chunks and related data types
Expand All @@ -31,50 +19,35 @@ Concept.hs
Constrained.hs
- Defines ConstrainedChunk and ConstrConcept data types

DataDefinition.hs
- Defines DataDefinition data type and constructors

DefinedQuantity.hs
- Defines DefinedQuantityDict data type and constructors

Derivation.hs
- Defines Derivation type

Eq.hs
- Defines QDefinition data type (quantity with units and defining equations)

GenDefn.hs
- General Definition chunks *TODO: Move from drasil-lang to drasil-docLang*

Goal.hs
- Goal statement chunks *TODO: Move from drasil-lang to drasil-docLang*

InstanceModel.hs
- Instance model chunks *TODO: Move from drasil-lang to drasil-docLang*

NamedIdea.hs
- NamedChunk and IdeaDict data types
- Various NamedChunk combinators

PhysSystDesc.hs
- Physical system description chunks *TODO: Move from drasil-lang to drasil-docLang*

Quantity.hs
- `Quantity` class definition
- Defines QuantityDict data type

README.md
- This file

References.hs
- Defines Reference type

Relation.hs
- Defines Relation chunks (Concepts with relations between other chunks).

ReqChunk.hs
- Defines Requirement chunks *TODO: Move from drasil-lang to drasil-docLang*

SymbolForm.hs
- Helper functions for getting staged symbols

Theory.hs
- `Theory` class definition
- TheoryChunk and TheoryModel data types *TODO: Move from drasil-lang to drasil-docLang*
Expand All @@ -94,5 +67,5 @@ UnitaryConcept.hs
- Defines UnitaryConceptDict data type *FIXME: Compare with Unital chunks and see if
they are actually different*

VarChunk.hs
- Defines VarChunk data type *FIXME: How is VarChunk different from QuantityDict?*
UnitDefn.hs
- Defines UnitDefn data type and constructors and helper functions

0 comments on commit a59c59e

Please sign in to comment.