René's URL Explorer Experiment


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

direct link

Domain: github.com

route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:b30872f9-2a9c-14ad-f1c8-0dd600fa87fe
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idD834:2A08B2:17BC7CD:2039782:697A97C5
html-safe-nonce9631fceeeb6b0e887670d76016c16c32e282c70e8395e431dc52aa84d201ff74
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEODM0OjJBMDhCMjoxN0JDN0NEOjIwMzk3ODI6Njk3QTk3QzUiLCJ2aXNpdG9yX2lkIjoiMjA0MjMzODU5NDA1MDk3MTU4OSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmacf90ce2fffec66fe5513071ea8ec4fd148440c8423d7cda39b77ea8fd48f746bc
hovercard-subject-tagpull_request:668976139
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/python-control/python-control/pull/633/files
twitter:imagehttps://avatars.githubusercontent.com/u/293362?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/293362?s=400&v=4
og:image:altThis 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_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
Nonef73c0dfa17dfe2bc934284d1387c1cedefe723d2133ede564feefd2cbeb98e55
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/python-control/python-control git https://github.com/python-control/python-control.git
octolytics-dimension-user_id2285872
octolytics-dimension-user_loginpython-control
octolytics-dimension-repository_id22791752
octolytics-dimension-repository_nwopython-control/python-control
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id22791752
octolytics-dimension-repository_network_root_nwopython-control/python-control
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release58b9322bb0d01c6949be2239e39780fa702e604c
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python-control/python-control/pull/633/changes#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-control%2Fpython-control%2Fpull%2F633%2Ffiles
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-control%2Fpython-control%2Fpull%2F633%2Ffiles
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=python-control%2Fpython-control
Reloadhttps://github.com/python-control/python-control/pull/633/changes
Reloadhttps://github.com/python-control/python-control/pull/633/changes
Reloadhttps://github.com/python-control/python-control/pull/633/changes
python-control https://github.com/python-control
python-controlhttps://github.com/python-control/python-control
Notifications https://github.com/login?return_to=%2Fpython-control%2Fpython-control
Fork 447 https://github.com/login?return_to=%2Fpython-control%2Fpython-control
Star 2k https://github.com/login?return_to=%2Fpython-control%2Fpython-control
Code https://github.com/python-control/python-control
Issues 87 https://github.com/python-control/python-control/issues
Pull requests 8 https://github.com/python-control/python-control/pulls
Discussions https://github.com/python-control/python-control/discussions
Actions https://github.com/python-control/python-control/actions
Projects 0 https://github.com/python-control/python-control/projects
Wiki https://github.com/python-control/python-control/wiki
Security 0 https://github.com/python-control/python-control/security
Insights https://github.com/python-control/python-control/pulse
Code https://github.com/python-control/python-control
Issues https://github.com/python-control/python-control/issues
Pull requests https://github.com/python-control/python-control/pulls
Discussions https://github.com/python-control/python-control/discussions
Actions https://github.com/python-control/python-control/actions
Projects https://github.com/python-control/python-control/projects
Wiki https://github.com/python-control/python-control/wiki
Security https://github.com/python-control/python-control/security
Insights https://github.com/python-control/python-control/pulse
Sign up for GitHub https://github.com/signup?return_to=%2Fpython-control%2Fpython-control%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fpython-control%2Fpython-control%2Fissues%2Fnew%2Fchoose
murrayrmhttps://github.com/murrayrm
python-control:masterhttps://github.com/python-control/python-control/tree/master
murrayrm:docstring_updateshttps://github.com/murrayrm/python-control/tree/docstring_updates
Conversation 17 https://github.com/python-control/python-control/pull/633
Commits 7 https://github.com/python-control/python-control/pull/633/commits
Checks 0 https://github.com/python-control/python-control/pull/633/checks
Files changed https://github.com/python-control/python-control/pull/633/files
Please reload this pagehttps://github.com/python-control/python-control/pull/633/changes
Documentation updates https://github.com/python-control/python-control/pull/633/changes#top
Show all changes 7 commits https://github.com/python-control/python-control/pull/633/files
fb65459 DOC: fix forced_response return arguments in documentation murrayrm Jun 12, 2021 https://github.com/python-control/python-control/pull/633/commits/fb6545939e78ae7d9ae9ad358619a93c5ad27870
d89dfd8 DOC: update iosys docstrings - params not optional for updfcn, outfcn murrayrm Jun 12, 2021 https://github.com/python-control/python-control/pull/633/commits/d89dfd863dafc901e60254da75ef353f789905d5
695cdfc DOC: fix LTI system attribute docstrings, add __call__, PEP8 cleanup murrayrm Jun 12, 2021 https://github.com/python-control/python-control/pull/633/commits/695cdfc45cee5ca8570ad9bf3410a836e353539a
bf2472f DOC: move constructor docs from __init__ to class; remove attr docs murrayrm Jun 12, 2021 https://github.com/python-control/python-control/pull/633/commits/bf2472f7f78ab748d41ed032ced9cc8f33bcfc11
70a6cf9 TRV: fix typos pointed out by @namannimmo10 murrayrm Jun 13, 2021 https://github.com/python-control/python-control/pull/633/commits/70a6cf91559ac6d5947743a980bc308e6a336239
bda7d82 DOC: fix inconsistencies in class constructor + class list documentation murrayrm Jun 15, 2021 https://github.com/python-control/python-control/pull/633/commits/bda7d82f2016fc89a0ddc4f0f6ccffa2a09e2d37
866a07c TRV: fix typos in FRD docstring murrayrm Jun 15, 2021 https://github.com/python-control/python-control/pull/633/commits/866a07c6de72de77680e34358e7959dc67b41ffa
Clear filters https://github.com/python-control/python-control/pull/633/files
Please reload this pagehttps://github.com/python-control/python-control/pull/633/changes
Please reload this pagehttps://github.com/python-control/python-control/pull/633/changes
descfcn.py https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
basis.py https://github.com/python-control/python-control/pull/633/changes#diff-4d1628be0ac467eeae964f0484605d32f083216773660fdfedb9d56c02a7748e
bezier.py https://github.com/python-control/python-control/pull/633/changes#diff-123c1531a9577a0e059978f323d4432428149ec4af2cfd52ea0e7c74549a78a6
flatsys.py https://github.com/python-control/python-control/pull/633/changes#diff-6fe8823920a89e1d41e1dd75a124d2139e96caf41093969a1070f219881d86cc
linflat.py https://github.com/python-control/python-control/pull/633/changes#diff-48f25f34ede67182a4f6094999656aa44a0ddef93de3c74d72b8d93c397f668d
systraj.py https://github.com/python-control/python-control/pull/633/changes#diff-53e9f3d5e6f2d4c8f4eff3240aabaf7786d4bb1e53bf818957078e7b380a47f3
frdata.py https://github.com/python-control/python-control/pull/633/changes#diff-cacf59417131c19becd6fba4dde9e979bed49ce572eb24f0f62bd2af460d83d1
iosys.py https://github.com/python-control/python-control/pull/633/changes#diff-12b378d96d36c9d59a9fbc5afbc7cc158d153ff7591b4769f8312772e1d74ed1
lti.py https://github.com/python-control/python-control/pull/633/changes#diff-9eb79d97f0ecfaf506be3bac9ab8573caf6301e9685c8bfa3e91632402fa4e5a
optimal.py https://github.com/python-control/python-control/pull/633/changes#diff-19ca2bf58874b6519164f42d62448fdcc1e05efe2b45263f6761f39392cdde01
statesp.py https://github.com/python-control/python-control/pull/633/changes#diff-b5aac033a6dd07653e82d9f5a40afaa775010c2d2d5af8beeb159487b566df72
iosys_test.py https://github.com/python-control/python-control/pull/633/changes#diff-2d9f6fd1b76261b8663bd7fa89565809a728c32edd8b0f6e095177f80b6e5100
xferfcn.py https://github.com/python-control/python-control/pull/633/changes#diff-0dd9424d3024fc1d5cc8fd67d13efe5703318c4c705526ab0ae216de69ce3de7
custom-class-template.rst https://github.com/python-control/python-control/pull/633/changes#diff-ec236dc3a1263a24462b9fe7605198d55102ddba2ff196b285e25f7baff3fc48
classes.rst https://github.com/python-control/python-control/pull/633/changes#diff-7ace42a025609df89447e9513968d95b8191259149e34bb7d088987aa28ec85e
conf.py https://github.com/python-control/python-control/pull/633/changes#diff-e170e9a7d787c21095c6c11bb25f0f1ff0294a42a46d45ba6fb5ed794e457624
control.rst https://github.com/python-control/python-control/pull/633/changes#diff-5a8429a2bfd64a7041b2ba651f0f4a0318299c85c8dd095c1150fe7c788ddcb4
conventions.rst https://github.com/python-control/python-control/pull/633/changes#diff-04f5af9adedfe548dc7beedc5952a1aff00fb279a868e337028b2487e655e2f4
descfcn.rst https://github.com/python-control/python-control/pull/633/changes#diff-f11755533e4fb085ee0568f9ab40317ebcfff1a0190533d732e951f4a0d08429
flatsys.rst https://github.com/python-control/python-control/pull/633/changes#diff-5a1faa02540e8a58e42c2af678151966c846be7ff868b3718cf7eebc3acab381
iosys.rst https://github.com/python-control/python-control/pull/633/changes#diff-65eeef9e016bf4e8497d036a1c484177a178fb456ca7f72258d8ce6f6fd81dfc
matlab.rst https://github.com/python-control/python-control/pull/633/changes#diff-7c58eb4602e1d8fc23ac37f3e26855692fa3be2946fa9e6fd1854db69f179cf9
optimal.rst https://github.com/python-control/python-control/pull/633/changes#diff-7a587fcc2ce0d45f27f08ebd590bad2db607818b399c646d0e2455ce96d9096e
control/descfcn.pyhttps://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
View file https://github.com/murrayrm/python-control/blob/866a07c6de72de77680e34358e7959dc67b41ffa/control/descfcn.py
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-control/python-control/pull/633/{{ revealButtonHref }}
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
https://github.com/python-control/python-control/pull/633/changes#diff-f0f5ffb2c67d9936a4896284a27a0b10ccc28b354bfbc7cc187460f1254a073d
control/flatsys/basis.pyhttps://github.com/python-control/python-control/pull/633/changes#diff-4d1628be0ac467eeae964f0484605d32f083216773660fdfedb9d56c02a7748e
View file https://github.com/murrayrm/python-control/blob/866a07c6de72de77680e34358e7959dc67b41ffa/control/flatsys/basis.py
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-control/python-control/pull/633/{{ revealButtonHref }}
https://github.com/python-control/python-control/pull/633/changes#diff-4d1628be0ac467eeae964f0484605d32f083216773660fdfedb9d56c02a7748e
https://github.com/python-control/python-control/pull/633/changes#diff-4d1628be0ac467eeae964f0484605d32f083216773660fdfedb9d56c02a7748e
control/flatsys/bezier.pyhttps://github.com/python-control/python-control/pull/633/changes#diff-123c1531a9577a0e059978f323d4432428149ec4af2cfd52ea0e7c74549a78a6
View file https://github.com/murrayrm/python-control/blob/866a07c6de72de77680e34358e7959dc67b41ffa/control/flatsys/bezier.py
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-control/python-control/pull/633/{{ revealButtonHref }}
https://github.com/python-control/python-control/pull/633/changes#diff-123c1531a9577a0e059978f323d4432428149ec4af2cfd52ea0e7c74549a78a6
https://github.com/python-control/python-control/pull/633/changes#diff-123c1531a9577a0e059978f323d4432428149ec4af2cfd52ea0e7c74549a78a6
control/flatsys/flatsys.pyhttps://github.com/python-control/python-control/pull/633/changes#diff-6fe8823920a89e1d41e1dd75a124d2139e96caf41093969a1070f219881d86cc
View file https://github.com/murrayrm/python-control/blob/866a07c6de72de77680e34358e7959dc67b41ffa/control/flatsys/flatsys.py
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-control/python-control/pull/633/{{ revealButtonHref }}
https://github.com/python-control/python-control/pull/633/changes#diff-6fe8823920a89e1d41e1dd75a124d2139e96caf41093969a1070f219881d86cc
https://github.com/python-control/python-control/pull/633/changes#diff-6fe8823920a89e1d41e1dd75a124d2139e96caf41093969a1070f219881d86cc
https://github.com/python-control/python-control/pull/633/changes#diff-6fe8823920a89e1d41e1dd75a124d2139e96caf41093969a1070f219881d86cc
https://github.com/python-control/python-control/pull/633/changes#diff-6fe8823920a89e1d41e1dd75a124d2139e96caf41093969a1070f219881d86cc
https://github.com/python-control/python-control/pull/633/changes#diff-6fe8823920a89e1d41e1dd75a124d2139e96caf41093969a1070f219881d86cc
control/flatsys/linflat.pyhttps://github.com/python-control/python-control/pull/633/changes#diff-48f25f34ede67182a4f6094999656aa44a0ddef93de3c74d72b8d93c397f668d
View file https://github.com/murrayrm/python-control/blob/866a07c6de72de77680e34358e7959dc67b41ffa/control/flatsys/linflat.py
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-control/python-control/pull/633/{{ revealButtonHref }}
https://github.com/python-control/python-control/pull/633/changes#diff-48f25f34ede67182a4f6094999656aa44a0ddef93de3c74d72b8d93c397f668d
https://github.com/python-control/python-control/pull/633/changes#diff-48f25f34ede67182a4f6094999656aa44a0ddef93de3c74d72b8d93c397f668d
control/flatsys/systraj.pyhttps://github.com/python-control/python-control/pull/633/changes#diff-53e9f3d5e6f2d4c8f4eff3240aabaf7786d4bb1e53bf818957078e7b380a47f3
View file https://github.com/murrayrm/python-control/blob/866a07c6de72de77680e34358e7959dc67b41ffa/control/flatsys/systraj.py
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python-control/python-control/pull/633/{{ revealButtonHref }}
https://github.com/python-control/python-control/pull/633/changes#diff-53e9f3d5e6f2d4c8f4eff3240aabaf7786d4bb1e53bf818957078e7b380a47f3
https://github.com/python-control/python-control/pull/633/changes#diff-53e9f3d5e6f2d4c8f4eff3240aabaf7786d4bb1e53bf818957078e7b380a47f3
Please reload this pagehttps://github.com/python-control/python-control/pull/633/changes
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width

URLs of crawlers that visited me.