Title: Wrong parameter name in documentation · Issue #987 · python-control/python-control · GitHub
Open Graph Title: Wrong parameter name in documentation · Issue #987 · python-control/python-control
X Title: Wrong parameter name in documentation · Issue #987 · python-control/python-control
Description: 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 documentatio...
Open Graph Description: 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 l...
X Description: 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,...
Opengraph URL: https://github.com/python-control/python-control/issues/987
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Wrong parameter name in documentation","articleBody":"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:\r\n\r\n```py\r\ndef root_locus_map(sysdata, gains=None):\r\n \"\"\"Compute the root locus map for an LTI system.\r\n\r\n Calculate the root locus by finding the roots of 1 + k * G(s) where G\r\n is a linear system with transfer function num(s)/den(s) and each k is\r\n an element of kvect.\r\n\r\n Parameters\r\n ----------\r\n sys : LTI system or list of LTI systems\r\n Linear input/output systems (SISO only, for now).\r\n kvect : array_like, optional\r\n Gains to use in computing plot of closed-loop poles.\r\n ...\r\n \"\"\"\r\n```\r\n\r\nNote that (the new) `gains` is used as a function parameter, but `kvect` is documented (the old parameter from `ct.root_locus`).","author":{"url":"https://github.com/Davide-sd","@type":"Person","name":"Davide-sd"},"datePublished":"2024-04-03T12:18:05.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/987/python-control/issues/987"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:b846364b-6dfa-f748-2eb8-d78b9a0eccd7 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B00C:2CE5BA:6775E9:92EB85:697A1D08 |
| html-safe-nonce | 300231f50b1a2607ca0040cbcaba1c4fcddf78880c9319525d327ddd69acb24a |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMDBDOjJDRTVCQTo2Nzc1RTk6OTJFQjg1OjY5N0ExRDA4IiwidmlzaXRvcl9pZCI6IjYwMjMwNTkzMTIxNDQ0MjQyMDEiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 7a0ed55c0a5b76d3814282156f95b27cf3f6787bfdcb9650e29915d93d956b83 |
| hovercard-subject-tag | issue:2222776955 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python-control/python-control/987/issue_layout |
| twitter:image | https://opengraph.githubassets.com/df7b2f54d40636cac30774de3964b3f9408453921a090ea388f58dfe334d9f26/python-control/python-control/issues/987 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/df7b2f54d40636cac30774de3964b3f9408453921a090ea388f58dfe334d9f26/python-control/python-control/issues/987 |
| og:image:alt | 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 l... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | Davide-sd |
| hostname | github.com |
| expected-hostname | github.com |
| None | 24021c77440f544078f9cbe80d78a2fb16ccff65fca92deda9da3c51d1cdc5fc |
| turbo-cache-control | no-preview |
| go-import | github.com/python-control/python-control git https://github.com/python-control/python-control.git |
| octolytics-dimension-user_id | 2285872 |
| octolytics-dimension-user_login | python-control |
| octolytics-dimension-repository_id | 22791752 |
| octolytics-dimension-repository_nwo | python-control/python-control |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 22791752 |
| octolytics-dimension-repository_network_root_nwo | python-control/python-control |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 2841ead760bbcdca99003cf970f91348178160c3 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width