GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GeezerVison is showing github.com — Documentation updates by murrayrm · Pull Request #633 · python-control/python-control Conversation
Member
This PR updates the documentation to resolve issue #604 and #631:
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.
Sorry, something went wrong. Uh oh!
There was an error while loading. Please reload this page. All reactions
This was
linked to
issues
|
There was an error while loading. Please reload this page.
|
Coverage increased (+0.03%) to 89.658% when pulling 866a07c on murrayrm:docstring_updates into 9f27293 on python-control:master. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Some typos to consider;
Sorry, something went wrong.
There was an error while loading. Please reload this page.
| smooth : bool, optional | ||
| If ``True``, create an interpoloation function that allows the | ||
| frequency response to be computed at any frequency within the range of | ||
| frquencies give in ``w``. If ``False`` (default), frequency response |
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
| frquencies give in ``w``. If ``False`` (default), frequency response | |
| frequencies give in ``w``. If ``False`` (default), frequency response |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
| w : iterable of real frequencies | ||
| List of frequency points for which data are available. | ||
| smooth : bool, optional | ||
| If ``True``, create an interpoloation function that allows the |
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
| If ``True``, create an interpoloation function that allows the | |
| If ``True``, create an interpolation function that allows the |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
| ninputs, noutputs, nstates : int | ||
| Number of input, output and state variables. | ||
| num, den : 2D list of array | ||
| Polynomial coeffients of the numerator and denominator. |
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
| Polynomial coeffients of the numerator and denominator. | |
| Polynomial coefficients of the numerator and denominator. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
| >>> s = TransferFunction.s | ||
| >>> G = (s + 1)/(s**2 + 2*s + 1) |
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
| >>> s = TransferFunction.s | |
| >>> G = (s + 1)/(s**2 + 2*s + 1) | |
| >>> s = TransferFunction.s | |
| >>> G = (s + 1)/(s**2 + 2*s + 1) |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
There is an inconsistency in the TOC tree:
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Just another typo:
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
7b81723 to
f4b09b6
Compare
f4b09b6 to
866a07c
Compare
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
update documentation for iosys/updfcn to indicate param is not optional __call__ and other new methods not described in sphinx docs
There was an error while loading. Please reload this page.