Small user documentation fixes #1042
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slivingston
approved these changes
Aug 17, 2024
Member
|
I tried building the documentation with the Sphinx nitpicky option, and there are more broken links. I will open a PR tonight or tomorrow. |
Member
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.rst
index 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.rst
index 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( |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes a few small glitches in the user documentation:
box_gridfunction was being included instead ofboxgrid.phaseplotmodule were omitting the requiredphaseplotprefix, so that it might look like the could be called asct.function(instead ofct.phaseplot.functionorpp.functionif you have importedcontrol.phaseplotaspp).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.