Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Documentation updates#633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
murrayrm merged 7 commits intopython-control:masterfrommurrayrm:docstring_updates
Jun 16, 2021

Conversation

murrayrm
Copy link
Member

This PR updates the documentation to resolve issue#604 and#631:

  • The docstring description for theupdfcn andoutfcn parameters forNonlinearIOSystem has been updated to reflect the fact that theparam argument is required (issueupdate documentation for iosys/updfcn to indicate param is not optional #631; see also discussionUsing 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.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 deprecatedinput,output, andstate attributes 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 versionhere.

@coveralls
Copy link

coveralls commentedJun 13, 2021
edited
Loading

Coverage Status

Coverage increased (+0.03%) to 89.658% when pulling866a07c on murrayrm:docstring_updates into9f27293 on python-control:master.

Copy link
Contributor

@namannimmo10namannimmo10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Some typos to consider;

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change
frquenciesgivein``w``.If``False`` (default),frequencyresponse
frequenciesgivein``w``.If``False`` (default),frequencyresponse

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change
If``True``,createaninterpoloationfunctionthatallowsthe
If``True``,createaninterpolationfunctionthatallowsthe

ninputs, noutputs, nstates : int
Number of input, output and state variables.
num, den : 2D list of array
Polynomial coeffients of the numerator and denominator.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change
Polynomialcoeffientsofthenumeratoranddenominator.
Polynomialcoefficientsofthenumeratoranddenominator.

Comment on lines 145 to 146
>>> s = TransferFunction.s
>>> G = (s + 1)/(s**2 + 2*s + 1)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change
>>>s=TransferFunction.s
>>>G= (s+1)/(s**2+2*s+1)
>>>s=TransferFunction.s
>>>G= (s+1)/(s**2+2*s+1)

Copy link
Contributor

@bnavigatorbnavigator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

There is an inconsistency in the TOC tree:

  • Differentially flat Systems
    • Module classes and functions
      • Flat system classes
        • control.flatsys.BasisFamily
        • ...
      • Flat system functions
  • Input/output systems
    • Module classes and functions
      • Input/output system classes -> Table with links to *Control system classes >> *
  • Describing functions
    • Module classes and functions
      • control.DescribingFunctionNonlinearity
      • ...
  • Optimal control
    • Module classes and functions
      • control.optimal.OptimalControlProblem
      • ...

Copy link
Contributor

@bnavigatorbnavigator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Looks good! Just another typo:

@murrayrmmurrayrm merged commitda27d35 intopython-control:masterJun 16, 2021
@murrayrmmurrayrm deleted the docstring_updates branchNovember 25, 2021 22:06
@murrayrmmurrayrm added this to the0.9.1 milestoneDec 30, 2021
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@namannimmo10namannimmo10namannimmo10 left review comments

@bnavigatorbnavigatorbnavigator approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.9.1
Development

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
4 participants
@murrayrm@coveralls@bnavigator@namannimmo10

[8]ページ先頭

©2009-2025 Movatter.jp