Title: Documentation updates by murrayrm · Pull Request #633 · python-control/python-control · GitHub
Open Graph Title: Documentation updates by murrayrm · Pull Request #633 · python-control/python-control
X Title: Documentation updates by murrayrm · Pull Request #633 · python-control/python-control
Description: This PR updates the documentation to resolve issue #604 and #631: The docstring description for the updfcn and outfcn parameters for NonlinearIOSystem has been updated to reflect the fact that the param argument is required (issue #631; see also discussion #630). The sphinx documentation for classes has been modified so that the __call__ method is now included in the documentation when it exists (issue #604). This required updating the sphinx conf.py file to allow special member functions to be included. I also put information in the class docstrings for transfer functions and state space systems about calling these objects to get the frequency response. The docstrings for classes yave been updated so that the sphinx documentation is now more uniform. The documentation for constructor arguments and attributes are now included in the class documentation and the __init__ docstring is suppressed in the sphinx-generated documentation (prior to this, it was sometimes in the class docstring and comes in the __init__ docstring). This change also allows the unwanted documentation of the deprecated input, output, and state attributes to be omitted (part of issue #604). Various other PEP8 and consistency issues were addressed. These changes required some refactoring the code, in particular in the use of the property decorator. I also changed some of the internal class attributes to be hidden attributes (names starting with underscore) since otherwise they show up in the documentation. The best way to see the impact of these changes is to look at the compiled documentation. You can find a version here.
Open Graph Description: This PR updates the documentation to resolve issue #604 and #631: The docstring description for the updfcn and outfcn parameters for NonlinearIOSystem has been updated to reflect the fact that th...
X Description: This PR updates the documentation to resolve issue #604 and #631: The docstring description for the updfcn and outfcn parameters for NonlinearIOSystem has been updated to reflect the fact that th...
Opengraph URL: https://github.com/python-control/python-control/pull/633
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:4602f6df-92f8-5b48-0dd3-147f1556be1d |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | CC50:2F593:37BE1D9:4C0CADE:6979D819 |
| html-safe-nonce | 5eabbfa101ce6fdb020d0e5347e8e9e2f3828d04a366c9e092744bfe9a2600f3 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDQzUwOjJGNTkzOjM3QkUxRDk6NEMwQ0FERTo2OTc5RDgxOSIsInZpc2l0b3JfaWQiOiIxNzEwMDcyNjMxMTc3ODkzOTEzIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | e8cd47fafe7525e05bfebcc7c592a32efdfd18001579ea6334cc95d6ff157822 |
| hovercard-subject-tag | pull_request:668976139 |
| 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/633/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 updates the documentation to resolve issue #604 and #631: The docstring description for the updfcn and outfcn parameters for NonlinearIOSystem has been updated to reflect the fact that th... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | c049b65ec7e54cbf2521f5a560b6527714c612b0bd169188e2ea6e16f83bd5f4 |
| 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 | aa81cb94735f56e8afe352515e35f16bd5c0018b |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width