Skip to content

Wrong parameter name in documentation #987

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
Davide-sd opened this issue Apr 3, 2024 · 1 comment · Fixed by #988
Closed

Wrong parameter name in documentation #987

Davide-sd opened this issue Apr 3, 2024 · 1 comment · Fixed by #988
Milestone
0.10.1

Comments

@Davide-sd
Copy link

I'm adapting my codes to control 0.10.0. In particular I'm switching from ct.root_locus to ct.root_locus_map in order to compute the root locus data. An error was raised in one of my tests, which led me to discover this. The documentation associated to root_locus_map is:

def root_locus_map(sysdata, gains=None):
    """Compute the root locus map for an LTI system.

    Calculate the root locus by finding the roots of 1 + k * G(s) where G
    is a linear system with transfer function num(s)/den(s) and each k is
    an element of kvect.

    Parameters
    ----------
    sys : LTI system or list of LTI systems
        Linear input/output systems (SISO only, for now).
    kvect : array_like, optional
        Gains to use in computing plot of closed-loop poles.
    ...
    """

Note that (the new) gains is used as a function parameter, but kvect is documented (the old parameter from ct.root_locus).
bnavigator added a commit to bnavigator/python-control that referenced this issue Apr 3, 2024
@bnavigator
Fix docstring
a0e5ea7 
Fixes python-controlgh-987
@bnavigator bnavigator mentioned this issue Apr 3, 2024
Merged
@bnavigator
Copy link
Contributor

Thanks! I made a small PR in #988. If there is more, please tell us or create your own PR!

@murrayrm murrayrm added this to the 0.10.1 milestone Apr 3, 2024
@murrayrm murrayrm mentioned this issue Apr 5, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.10.1
Development

Successfully merging a pull request may close this issue.

Fix docstring for root_locus_map bnavigator/python-control
3 participants
@murrayrm @bnavigator @Davide-sd