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 — Wrong parameter name in documentation · Issue #987 · python-control/python-control

Wrong parameter name in documentation #987

New issue
Copy link
New issue
Copy link
Closed
#988
Closed
Wrong parameter name in documentation#987
#988
Copy link
Milestone
0.10.1

Description

@Davide-sd
Davide-sd
opened on Apr 3, 2024
Issue body actions

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).

Activity

  1. bnavigator
    added a commit that references this issue on Apr 3, 2024

    Fix docstring

    This issue will close once commit a0e5ea7 is merged into the 'main' branch.
    a0e5ea7
  2. bnavigator commented on Apr 3, 2024

    @bnavigator
    bnavigator
    on Apr 3, 2024
    Contributor
    More actions

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

  3. murrayrm
    closed this as completedin #988on Apr 3, 2024
  4. murrayrm
    added this to the 0.10.1 milestone on Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      • 0.10.1No due date

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402520 — 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.