Skip to content

Commit 42e051c

Browse files
Merge pull request #275 from jaakkor2/docupdates
Tiny blocks documentation updates
2 parents 8fa353c + 4f18498 commit 42e051c

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

src/Blocks/continuous.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ end
7676
"""
7777
FirstOrder(; name, k = 1.0, T, x = 0.0, lowpass = true)
7878
79-
A first-order filter with a single real pole in `s = -T` and gain `k`. If `lowpass=true` (default), the transfer function
79+
A first-order filter with a single real pole at `s = -1/T` and gain `k`. If `lowpass=true` (default), the transfer function
8080
is given by ``Y(s)/U(s) = ``
8181
8282

src/Blocks/sources.jl

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,12 @@ end
157157
Cosine(; name, frequency, amplitude = 1, phase = 0, offset = 0, start_time = 0,
158158
smooth = false)
159159
160-
Cosine signal.
160+
Generate cosine signal.
161161
162162
# Parameters:
163-
- `frequency`: [Hz] Frequency of sine wave
164-
- `amplitude`: Amplitude of sine wave
165-
- `phase`: [rad] Phase of sine wave
163+
- `frequency`: [Hz] Frequency of cosine wave
164+
- `amplitude`: Amplitude of cosine wave
165+
- `phase`: [rad] Phase of cosine wave
166166
- `offset`: Offset of output signal
167167
- `start_time`: [s] Output `y = offset` for `t < start_time`
168168
- `smooth`: If `true`, returns a smooth wave. Defaults to `false`
@@ -171,7 +171,6 @@ Cosine signal.
171171
# Connectors:
172172
- `output`
173173
"""
174-
175174
@component function Cosine(; name,
176175
frequency,
177176
amplitude = 1,

src/Blocks/utils.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ end
4747
Connector with one output signal of type Real.
4848
4949
# Parameters:
50-
- `nout=1`: Number of inputs
50+
- `nout=1`: Number of outputs
5151
- `u_start=0`: Initial value for `u`
5252
5353
# States:
@@ -61,8 +61,8 @@ Single input single output (SISO) continuous system block.
6161
6262
# Parameters:
6363
64-
- `u`: Initial value for the input
65-
- `y`: Initial value for the output
64+
- `u_start`: Initial value for the input
65+
- `y_start`: Initial value for the output
6666
"""
6767
@mtkmodel SISO begin
6868
@parameters begin

0 commit comments

Comments
 (0)