- Notifications
You must be signed in to change notification settings - Fork441
Small user documentation fixes#1042
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
coveralls commentedAug 17, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
I tried building the documentation with theSphinx nitpicky option, and there are more broken links. I will open a PR tonight or tomorrow. |
Not enough to motivate another PR yet, so to avoid delaying the release, I include the diffs below in case you want to add them to this PR. diff --git a/doc/plotting.rst b/doc/plotting.rstindex a4611f1..7d8d442 100644--- a/doc/plotting.rst+++ b/doc/plotting.rst@@ -214,7 +216,7 @@ plot, use `plot_type='nichols'`:: .. image:: freqplot-siso_nichols-default.png Another response function that can be used to generate Bode plots is-the :func:`~control.gangof4` function, which computes the four primary+the :func:`~control.gangof4_response` function, which computes the four primary sensitivity functions for a feedback control system in standard form:: proc = ct.tf([1], [1, 1, 1], name="process") diff --git a/doc/iosys.rst b/doc/iosys.rstindex eb4311e..ec0a528 100644--- a/doc/iosys.rst+++ b/doc/iosys.rst@@ -25,7 +25,7 @@ a :class:`~control.StateSpace` linear system. Use the ss_sys = ct.linearize(io_sys, xeq, ueq) Input/output systems are automatically created for state space LTI systems-when using the :func:`ss` function. Nonlinear input/output systems can be+when using the :func:`~control.ss` function. Nonlinear input/output systems can be created using the :func:`~control.nlsys` function, which requires the definition of an update function (for the right hand side of the differential or different equation) and an output function (computes the@@ -435,7 +435,7 @@ of an individual system are used in a given specification:: ) And finally, since we have named the signals throughout the system in-a consistent way, we could let :func:`ct.interconnect` do all of the+a consistent way, we could let :func:`~control.interconnect` do all of the work:: clsys5 = ct.interconnect( |
6d42088
intopython-control:mainUh oh!
There was an error while loading.Please reload this page.
This PR fixes a few small glitches in the user documentation:
box_grid
function was being included instead ofboxgrid
.phaseplot
module were omitting the requiredphaseplot
prefix, so that it might look like the could be called asct.function
(instead ofct.phaseplot.function
orpp.function
if you have importedcontrol.phaseplot
aspp
).This doesn't really need review. I'll leave it here for a few hours just in case someone wants to have a look, but I'll merge it in when I work on the 0.10.1 release starting later tonight (PDT) or tomorrow.