Skip to content

root locus plot omega-damping grid appearing by default #1131

Closed

Description

@mjdunlop

I'm encountering a minor issue with control.root_locus. The documentation says the default behavior has the omega-damping grid set to False, but it's appearing unless I actually set grid = False.

Here are the versions I'm working with:
control 0.10.1
matplotlib 3.10.0
I'm seeing this in both a Jupyter Notebook and Google Colab.

Here's an example of the issue:
Image
Image

Here's what it looks like if grid = False:
Image

Activity

  1. slivingston commented on Feb 27, 2025

    @slivingston
    Member

    Can you point to where in the documentation the default value is indicated?

    There is a new release coming soon (#1130) that might already include a fix for this, but the function description in the current release docs seem to have the correct default, i.e., the value of config.defaults['rlocus.grid']

  2. mjdunlop commented on Feb 27, 2025

    @mjdunlop
    Author

    Ah! I think my google searching had turned up a previous version of the documentation (here). So it looks like the default behavior actually is okay. Thanks!

  3. slivingston commented on Feb 28, 2025

    @slivingston
    Member

    ReadTheDocs will add a warning banner when viewing docs from older versions or from current development (main branch, but not released yet) if a stable version is known. For example, see the warning on the mypy "latest" docs: https://mypy.readthedocs.io/en/latest/builtin_types.html

    https://python-control.readthedocs.io does not show a "stable" option, so I guess that ReadTheDocs is failing to detect that 0.10.1 (the most recent version-like tag) should be "stable." Until we fix this, a warning banner will not be shown.

    @murrayrm can you access the ReadTheDocs administrative view to check whether there is any indication of why "stable" is not being labeled? Feel free to delegate...I do not have ReadTheDocs admin access and don't know who does.

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

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions