Title: Documentation updates and testing by murrayrm · Pull Request #1038 · python-control/python-control · GitHub
Open Graph Title: Documentation updates and testing by murrayrm · Pull Request #1038 · python-control/python-control
X Title: Documentation updates and testing by murrayrm · Pull Request #1038 · python-control/python-control
Description: This PR provides updated docstrings for a large number of functions that had undocumented arguments, along with a unit test that checks to make sure that positional arguments and keyword arguments are appropriately documented. The unit test (docstring_test.py) checks for the following: All named arguments should be documented in the docstring using standard Python docstring syntax (parameter name followed by a space, then a colon, then another space). Detectable keyword arguments accessed via **kwargs are also checked to make sure they are documented. Exceptions are allowed to skip testing for entire functions or specific arguments in selected functions. Functions with unnamed positional arguments (*args) must be checked manually and an MD5 hash on the source code is used to make sure that changes will require reconfirmation (by updating the stored hash). Deprecated functions must contain a Sphynx deprecation message and issue a FutureWarning. Implementing this unit test picked up ~30 undocumented variables that are now documented, as well as triggering a few changes in argument processing and some argument hiding (for internal arguments that the user should never call, which now should start with an underscore). This PR contains no changes in functionality, just docstring updates and small code changes for consistency (eg, DeprecationWarning [which is ignored/hidden by default] → FutureWarning [which generates a user-visible warning]).
Open Graph Description: This PR provides updated docstrings for a large number of functions that had undocumented arguments, along with a unit test that checks to make sure that positional arguments and keyword arguments ...
X Description: This PR provides updated docstrings for a large number of functions that had undocumented arguments, along with a unit test that checks to make sure that positional arguments and keyword arguments ...
Opengraph URL: https://github.com/python-control/python-control/pull/1038
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:9ab1543e-d02e-4c68-6022-04eea7de882b |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | C06E:2BD61D:321D18B:42FE188:697AE615 |
| html-safe-nonce | f0c6cda7914f0f7101844726a5efeb81b46f0d7f8b320d25119dbf41b51c8abe |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMDZFOjJCRDYxRDozMjFEMThCOjQyRkUxODg6Njk3QUU2MTUiLCJ2aXNpdG9yX2lkIjoiMjc5MTQ4NzM1ODQxNzY5MjE4MSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | cf2341a7de7e8d0f9b2c6d60a59070787af84937410039bfdbf43f49ca442c9b |
| hovercard-subject-tag | pull_request:2011632798 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,checks,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/python-control/python-control/pull/1038/checks |
| twitter:image | https://avatars.githubusercontent.com/u/293362?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/293362?s=400&v=4 |
| og:image:alt | This PR provides updated docstrings for a large number of functions that had undocumented arguments, along with a unit test that checks to make sure that positional arguments and keyword arguments ... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | acb44186e5993a96be5027102cfa89a9a5fdd69da273fa313019549e77bf0f60 |
| 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 full-width full-width-p-0 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | a468b3a5db28b95af32540a83825720c4311de46 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width