Skip to content

Commit abebc93

Browse files
committed
Improve comments on traceGCon' and rename to genTraceGraphLabCons.
1 parent 9ec0e50 commit abebc93

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

code/drasil-docLang/lib/Drasil/DocumentLanguage.hs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ import qualified Drasil.Sections.Stakeholders as Stk (stakeholderIntro,
6363
import qualified Drasil.DocumentLanguage.TraceabilityMatrix as TM (
6464
generateTraceTableView, traceMHeader, layoutUIDs)
6565
import qualified Drasil.DocumentLanguage.TraceabilityGraph as TG (traceMGF)
66-
import Drasil.DocumentLanguage.TraceabilityGraph (traceyGraphGetRefs, traceGCon')
66+
import Drasil.DocumentLanguage.TraceabilityGraph (traceyGraphGetRefs, genTraceGraphLabCons)
6767
import Drasil.Sections.TraceabilityMandGs (traceMatStandard)
6868
import Drasil.Sections.ReferenceMaterial (emptySectSentPlu)
6969

@@ -105,7 +105,9 @@ fillLC sd si@SI{ _sys = sn }
105105
| otherwise = si
106106
where
107107
chkdb = si ^. systemdb
108-
createdLCs = traceGCon' $ programName sn -- Pre-generate a copy of all LabelledContents for insertion in the ChunkDB.
108+
-- Pre-generate a copy of all required LabelledContents (i.e., traceability
109+
-- graphs) for insertion in the ChunkDB.
110+
createdLCs = genTraceGraphLabCons $ programName sn
109111
-- FIXME: This is a semi-hack. This is only strictly necessary for the
110112
-- traceability graphs. Those are all chunks that should exist but not be
111113
-- handled like this. They should be created and included in the

code/drasil-docLang/lib/Drasil/DocumentLanguage/TraceabilityGraph.hs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,12 +162,14 @@ traceGLst = UlC $ ulcc $ Enumeration $ Bullet $ map (, Nothing) folderList'
162162

163163
-- | The Traceability Graph contents.
164164
traceGCon :: String -> [Contents] -- FIXME: HACK: We're generating "LlC"s of the traceability graphs multiple times... See DocumentLanguage.hs' mkTraceabilitySec for the other spot.
165-
traceGCon ex = map LlC (traceGCon' ex)
165+
traceGCon ex = map LlC (genTraceGraphLabCons ex)
166166
++ [mkParagraph $ S "For convenience, the following graphs can be\
167167
\ found at the links below:", traceGLst]
168168

169-
traceGCon' :: String -> [LabelledContent]
170-
traceGCon' ex = zipWith (traceGraphLC ex) traceGFiles traceGUIDs
169+
-- | Generate the `LabelledContent` chunks, specialized to a specific example
170+
-- (and its path).
171+
genTraceGraphLabCons :: String -> [LabelledContent]
172+
genTraceGraphLabCons ex = zipWith (traceGraphLC ex) traceGFiles traceGUIDs
171173

172174
-- | Generates traceability graphs as figures on an SRS document.
173175
traceGraphLC :: String -> FilePath -> UID -> LabelledContent

0 commit comments

Comments
 (0)