Skip to content

Commit 59a676e

Browse files
committed
fix typos in doc, docstrings pointed out by @slivingston review
1 parent b7c158b commit 59a676e

File tree

3 files changed

+14
-15
lines changed

3 files changed

+14
-15
lines changed

control/frdata.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -806,7 +806,7 @@ def frd(*args, **kwargs):
806806
>>> F = ct.frd(response, omega)
807807
808808
>>> G = ct.tf([1], [1, 1])
809-
>>> freqs = [1, 10, 100]
809+
>>> omega = [1, 10, 100]
810810
>>> F = ct.frd(G, omega)
811811
812812
"""

control/freqplot.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ def bode_plot(
111111
List of LTI systems or :class:`FrequencyResponseData` objects. A
112112
single system or frequency response can also be passed.
113113
omega : array_like, optoinal
114-
Set of frequencies in rad/sec over to plot over. If not specified,
115-
this will be determined from the proporties of the systems. Ignored
116-
if `data` is not a list of systems.
114+
Set of frequencies in rad/sec to plot over. If not specified, this
115+
will be determined from the proporties of the systems. Ignored if
116+
`data` is not a list of systems.
117117
*fmt : :func:`matplotlib.pyplot.plot` format string, optional
118118
Passed to `matplotlib` as the format string for all lines in the plot.
119119
The `omega` parameter must be present (use omega=None if needed).
@@ -2235,7 +2235,7 @@ def singular_values_plot(
22352235
-------
22362236
legend_loc : str, optional
22372237
For plots with multiple lines, a legend will be included in the
2238-
given location. Default is 'center right'. Use False to supress.
2238+
given location. Default is 'center right'. Use False to suppress.
22392239
lines : array of Line2D
22402240
1-D array of Line2D objects. The size of the array matches
22412241
the number of systems and the value of the array is a list of

doc/plotting.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ sensitivity functions for a feedback control system in standard form::
223223

224224
.. image:: freqplot-gangof4.png
225225

226-
Nyquist analysys can be done using the :func:`~control.nyquist_response`
226+
Nyquist analysis can be done using the :func:`~control.nyquist_response`
227227
function, which evaluates an LTI system along the Nyquist contour, and
228228
the :func:`~control.nyquist_plot` function, which generates a Nyquist plot::
229229

@@ -233,18 +233,17 @@ the :func:`~control.nyquist_plot` function, which generates a Nyquist plot::
233233
.. image:: freqplot-nyquist-default.png
234234

235235
The :func:`~control.nyquist_response` function can be used to compute
236-
the number of encirclement of the -1 point and can return the Nyquist
236+
the number of encirclements of the -1 point and can return the Nyquist
237237
contour that was used to generate the Nyquist curve.
238238

239239
By default, the Nyquist response will generate small semicircles around
240240
poles that are on the imaginary axis. In addition, portions of the Nyquist
241-
curve that far from the origin are scaled to a maximum value, with the line
242-
style is changed to reflect the scaling, and it is possible to offset the
243-
scaled portions to separate out the portions of the Nyquist curve at
244-
<math>\infty</math>. A number of keyword parameters for both are available
245-
for :func:`~control.nyquist_response`and :func:`~control.nyquist_plot` to
246-
tune the computation of the Nyquist curve and the way the data are
247-
plotted::
241+
curve that are far from the origin are scaled to a maximum value, while the
242+
line style is changed to reflect the scaling, and it is possible to offset
243+
the scaled portions to separate out the portions of the Nyquist curve at
244+
:math:`\infty`. A number of keyword parameters for both are available for
245+
:func:`~control.nyquist_response` and :func:`~control.nyquist_plot` to tune
246+
the computation of the Nyquist curve and the way the data are plotted::
248247

249248
sys = ct.tf([1, 0.2], [1, 0, 1]) * ct.tf([1], [1, 0])
250249
nyqresp = ct.nyquist_response(sys)
@@ -267,7 +266,7 @@ array of frequencies as a second argument (after the list of systems)::
267266

268267
.. image:: freqplot-siso_bode-omega.png
269268

270-
Alternatively. frequency ranges can be specified by passing a list of the
269+
Alternatively, frequency ranges can be specified by passing a list of the
271270
form ``[wmin, wmax]``, where ``wmin`` and ``wmax`` are the minimum and
272271
maximum frequencies in the (log-spaced) frequency range::
273272

0 commit comments

Comments
 (0)