Skip to content

Commit

Permalink
#3252 Sentence Reworking (for the Dblpend Example, Satisfied requirem…
Browse files Browse the repository at this point in the history
…ent) (#3958)

* #3252 Sentence Reworking (for the Dblpend Example, Satisfied requirements)

Re-work some existing sentences by inserting defined concepts inside.

* Fix Body.hs from suggestions

Fix one parenthesis minor typo
  • Loading branch information
daijingz authored Sep 15, 2024
1 parent eb97983 commit 9c094d8
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions code/drasil-example/dblpend/lib/Drasil/DblPend/Body.hs
Original file line number Diff line number Diff line change
Expand Up @@ -216,32 +216,32 @@ charsOfReader = [phrase undergraduate +:+ S "level 2" +:+ phrase Doc.physics,
sysCtxIntro :: CI -> Contents
sysCtxIntro prog = foldlSP
[refS sysCtxFig1, S "shows the" +:+. phrase sysCont,
S "A circle represents an entity external to the", phrase software
S "A circle represents an entity external" `S.toThe` phrase software
`sC` phraseNP (the user), S "in this case. A rectangle represents the",
phrase softwareSys, S "itself", sParen (short prog) +:+. EmptyS,
S "Arrows are used to show the data flow between the", phraseNP (system
S "Arrows" `S.are` S "used to show the data flow between the", phraseNP (system
`andIts` environment)]

sysCtxDesc :: Contents
sysCtxDesc = foldlSPCol [S "The interaction between the", phraseNP (product_
`andThe` user), S "is through an application programming" +:+.
phrase interface, S "The responsibilities of the", phraseNP (user
phrase interface, S "The responsibilities" `S.ofThe` phraseNP (user
`andThe` system), S "are as follows"]

sysCtxUsrResp :: CI -> [Sentence]
sysCtxUsrResp prog = [S "Provide initial" +:+ pluralNP (condition `ofThePS`
physical) +:+ S "state of the" +:+ phrase motion +:+ S "and the" +:+ plural inDatum +:+ S "related to the" +:+
physical) +:+ S "state" `S.ofThe` phrase motion +:+ S "and the" +:+ plural inDatum +:+ S "related to the" +:+
phrase prog `sC` S "ensuring no errors in the" +:+
plural datum +:+. S "entry",
S "Ensure that consistent units are used for" +:+. pluralNP (combineNINI input_ Doc.variable),
S "Ensure that consistent units" `S.are` S "used for" +:+. pluralNP (combineNINI input_ Doc.variable),
S "Ensure required" +:+
namedRef (SRS.assumpt ([]::[Contents]) ([]::[Section])) (phrase software +:+ plural assumption) +:+
S "are appropriate for any particular" +:+
phrase problem +:+ S "input to the" +:+. phrase software]

sysCtxSysResp :: [Sentence]
sysCtxSysResp = [S "Detect data type mismatch, such as a string of characters" +:+
phrase input_ +:+. S "instead of a floating point number",
phrase input_ +:+. (S "instead" `S.ofA` S "floating point number"),
S "Determine if the" +:+ plural input_ +:+ S "satisfy the required" +:+.
pluralNP (physical `and_` softwareConstraint),
S "Calculate the required" +:+. plural output_,
Expand Down
2 changes: 1 addition & 1 deletion code/drasil-example/dblpend/lib/Drasil/DblPend/IMods.hs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ angleDerivSent1, angleDerivSent2, angleDerivSent3,
angleDerivSent4, angleDerivSent5, angleDerivSent6 :: Sentence
angleDerivSent1 = foldlSentCol [S "By solving equations" +:+ refS xForceGD_2 `S.and_` refS yForceGD_2
`S.for` eS forceDerivExpr1 `S.and_` eS forceDerivExpr2 `S.and_` S "then substituting into equation" +:+
refS xForceGD_1 `S.and_` refS yForceGD_1 +:+ S ", We can get equations 1 and 2"]
refS xForceGD_1 `S.and_` refS yForceGD_1 +:+ S ", we can get equations 1 and 2"]
angleDerivSent2 = foldlSentCol [S "Multiply the equation 1 by" +:+
eS cosAngleExpr1 `S.and_` S "the equation 2 by" +:+ eS sinAngleExpr1 `S.and_`
S "rearrange to get"]
Expand Down
2 changes: 1 addition & 1 deletion code/stable/dblpend/SRS/HTML/DblPend_SRS.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion code/stable/dblpend/SRS/Jupyter/DblPend_SRS.ipynb

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion code/stable/dblpend/SRS/PDF/DblPend_SRS.tex

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion code/stable/dblpend/SRS/mdBook/src/SecIMs.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 9c094d8

Please sign in to comment.