Skip to content

Commit

Permalink
#3252 Sentence Reworking (for the PdController Example, Part 2) (#3957)
Browse files Browse the repository at this point in the history
* #3252 Preparation Works

1. Update stack.yaml to fix one compatible error.
2. Fix some minor grammar and clarity typos.

* Remove stack.yaml changes

Remove stack changes and split it into another PR

* #3252 Sentence Reworking (for the Glassbr Example)

Extract the most worthy places to re-format sentences, and rework on them.

* Remove stack.yaml changes

Remove dependency changes on stack.yaml.

* #3252 Sentence Reworking (for the PdController Example, Part 1)

Re-work some existing sentences by inserting defined concepts inside.
  • Loading branch information
daijingz authored Sep 15, 2024
1 parent fd0109e commit eb97983
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ derivStmt1 :: Sentence
derivStmt1
= foldlSent
[atStartNP (the processVariable), eS' qdProcessVariableFD, S "in a", phrase pidCL +:+
S "is the product of the", phrase processError, fromSource ddErrSig `sC`
S "is the product" `S.ofThe` phrase processError, fromSource ddErrSig `sC`
phrase controlVariable, fromSource ddCtrlVar `sC` EmptyS
`S.andThe` phrase powerPlant, fromSource gdPowerPlant]

Expand Down Expand Up @@ -107,7 +107,7 @@ derivStmt4
[atStartNP (the setPoint), eS' qdSetPointTD, S "is a step function and a constant" +:+.
fromSource aSP,
S "Therefore the",
S "differential of the set point is zero. Hence the equation",
S "differential" `S.ofThe` S "set point" `S.is` S "zero. Hence the equation",
S "reduces to"]

derivEqn4 :: ModelExpr
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ introPara
= foldlSent
[S "Automatic process control with a controller (P/PI/PD/PID) is used",
S "in a variety of applications such as thermostats, automobile",
S "cruise-control, etc. The gains of a controller in an application" +:+.
S "cruise-control, etc. The gains" `S.ofA` S "controller in an application" +:+.
S "must be tuned before the controller is ready for production",
S "Therefore, a simulation of the", phrase pidC, S "with a",
S "Therefore, a simulation" `S.ofThe` phrase pidC, S "with a",
phrase secondOrderSystem,
S "is created in this project based on the original, manually created version of" +:+
S "is created in this project based" `S.onThe` S "original, manually created version of" +:+
namedRef externalLinkRef (S "PD Controller"),
S "that can be used to tune the gain constants"]

Expand All @@ -29,17 +29,17 @@ introscopeOfReq
S "with three subsystems, namely:" +:+.
foldlList Comma List (map (phraseNP.a_)
[pidC, summingPt, powerPlant]),
S "Only the Proportional and Derivative controllers are used in this software;" +:+.
S "the Integral controller is beyond the scope of this project",
S "Additionally, this software is intended to aid with the manual",
S "tuning of the", phrase pidC]
S "Only the Proportional and Derivative controllers" `S.are` S "used in this software;" +:+.
(S "the Integral controller" `S.is` S "beyond the scope of this project"),
S "Additionally, this software" `S.is` S "intended to aid with the manual",
S "tuning" `S.ofThe` phrase pidC]

introPurposeOfDoc
= foldlSent
[S "The purpose of this document is to capture all the necessary",
S "information including assumptions, data definitions, constraints,",
S "models, and requirements to facilitate an unambiguous development"
`S.ofThe` phrase pidC, S "software and test procedures"]
[S "The purpose of this document" `S.is` S "to capture all the necessary",
S "information including assumptions, data definitions, constraints,",
S "models, and requirements to facilitate an unambiguous development"
`S.ofThe` phrase pidC, S "software and test procedures"]

introUserChar1, introUserChar2 :: [Sentence]
introUserChar1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ invLaplaceDesc
= foldlSent
[(S "Inverse Laplace Transform of F(S)" !.),
S "The Inverse Laplace transforms are",
S "typically inferred from a pre-computed table of Laplace Transforms",
S "typically inferred from a pre-computed table" `S.of_` S "Laplace Transforms",
sParen (refS laplaceWiki)]

--------
Expand Down

0 comments on commit eb97983

Please sign in to comment.