Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
murrayrm merged 3 commits intopython-control:mainfrommurrayrm:docfix-16Aug2024
Aug 17, 2024

Conversation

murrayrm
Copy link
Member

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

  • The deprecatedbox_grid function was being included instead ofboxgrid.
  • References to thephaseplot 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).
  • 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.

@coveralls
Copy link

coveralls commentedAug 17, 2024
edited
Loading

Coverage Status

coverage: 94.694%. remained the same
when pullingd176201 on murrayrm:docfix-16Aug2024
intof86ebda on python-control:main.

@slivingston
Copy link
Member

I tried building the documentation with theSphinx nitpicky option, and there are more broken links. I will open a PR tonight or tomorrow.

@slivingston
Copy link
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.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(

@murrayrmmurrayrm merged commit6d42088 intopython-control:mainAug 17, 2024
12 checks passed
@murrayrmmurrayrm deleted the docfix-16Aug2024 branchAugust 17, 2024 12:34
@murrayrmmurrayrm added this to the0.10.1 milestoneFeb 19, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@slivingstonslivingstonslivingston approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.10.1
Development

Successfully merging this pull request may close these issues.

3 participants
@murrayrm@coveralls@slivingston

[8]ページ先頭

©2009-2025 Movatter.jp