Documentation updates #633
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was
linked to
issues
Jun 13, 2021
control/frdata.py
Outdated
| 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.
Suggested change
| frquencies give in ``w``. If ``False`` (default), frequency response | |
| frequencies give in ``w``. If ``False`` (default), frequency response |
control/frdata.py
Outdated
| 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.
Suggested change
| If ``True``, create an interpoloation function that allows the | |
| If ``True``, create an interpolation function that allows the |
control/xferfcn.py
Outdated
| 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.
Suggested change
| Polynomial coeffients of the numerator and denominator. | |
| Polynomial coefficients of the numerator and denominator. |
control/xferfcn.py
Outdated
Comment on lines
145
to
146
| >>> s = TransferFunction.s | ||
| >>> G = (s + 1)/(s**2 + 2*s + 1) |
There was a problem hiding this comment.
Suggested change
| >>> s = TransferFunction.s | |
| >>> G = (s + 1)/(s**2 + 2*s + 1) | |
| >>> s = TransferFunction.s | |
| >>> G = (s + 1)/(s**2 + 2*s + 1) |
bnavigator
reviewed
Jun 14, 2021
There was a problem hiding this comment.
There is an inconsistency in the TOC tree:
- Differentially flat Systems
- Module classes and functions
- Flat system classes
- control.flatsys.BasisFamily
- ...
- Flat system functions
- Flat system classes
- Module classes and functions
- Input/output systems
- Module classes and functions
- Input/output system classes -> Table with links to *Control system classes >> *
- Module classes and functions
- Describing functions
- Module classes and functions
- control.DescribingFunctionNonlinearity
- ...
- Module classes and functions
- Optimal control
- Module classes and functions
- control.optimal.OptimalControlProblem
- ...
- Module classes and functions
bnavigator
reviewed
Jun 15, 2021
7b81723 to
f4b09b6
Compare
f4b09b6 to
866a07c
Compare
bnavigator
approved these changes
Jun 15, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation to resolve issue #604 and #631:
The docstring description for the
updfcnandoutfcnparameters forNonlinearIOSystemhas been updated to reflect the fact that theparamargument is required (issue update documentation for iosys/updfcn to indicate param is not optional #631; see also discussion Using a class method in a NonlinearIOSystem #630).The sphinx documentation for classes has been modified so that the
__call__method is now included in the documentation when it exists (issue __call__ and other new methods not described in sphinx docs #604). This required updating the sphinxconf.pyfile 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 deprecatedinput,output, andstateattributes to be omitted (part of issue __call__ and other new methods not described in sphinx docs #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.