GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Small user documentation fixes by murrayrm · Pull Request #1042 · python-control/python-control

Conversation

@murrayrm

@murrayrm murrayrm commented Aug 17, 2024

Copy link
Copy Markdown
Member

This PR fixes a few small glitches in the user documentation:

  • The deprecated box_grid function was being included instead of boxgrid.
  • References to the phaseplot module were omitting the required phaseplot prefix, so that it might look like the could be called as ct.function (instead of ct.phaseplot.function or pp.function if you have imported control.phaseplot as pp).
  • There was an incorrect reference in the optimization-based control module than I found and fixed along the way.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
murrayrm added 2 commits August 16, 2024 17:45
@murrayrm
DOC: box_grid -> boxgrid + fix module path refs
d44bc84
@murrayrm
fix up a few referencs in optimal documentation
7b9664c
@coveralls

coveralls commented Aug 17, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Coverage Status

coverage: 94.694%. remained the same
when pulling d176201 on murrayrm:docfix-16Aug2024
into f86ebda on python-control:main.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

slivingston
slivingston approved these changes Aug 17, 2024
View reviewed changes
@slivingston

slivingston commented Aug 17, 2024

Copy link
Copy Markdown
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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@slivingston

slivingston commented Aug 17, 2024

Copy link
Copy Markdown
Member

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.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(
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@murrayrm
fix additional broken links (from @slivingston review)
d176201
@murrayrm
murrayrm merged commit 6d42088 into python-control:main Aug 17, 2024
@murrayrm
murrayrm deleted the docfix-16Aug2024 branch August 17, 2024 12:34
@murrayrm murrayrm added this to the 0.10.1 milestone Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@slivingston slivingston slivingston approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.10.1

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@murrayrm @coveralls @slivingston
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.