Skip to content

Documentation updates #360

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 13 commits into from
Jan 4, 2020
Merged

Documentation updates #360

merged 13 commits into from
Jan 4, 2020

Conversation

murrayrm
Copy link
Member

@murrayrm murrayrm commented Jan 2, 2020

This PR includes a number of documentation updates:

  • Added information on how time responses are computed (based feedback from a user)
  • Added a new section "Examples" to the online documentation that includes both scripts and Jupyter notebooks demonstrate the use of the toolbox
  • Split out the section on input/output systems from "Conventions" to its own section and added an example showing its use (in addition to what is in the Examples section).
  • Various small fixes to docstrings, including the problems identified in issue Readthedocs issues to be fixed #358.

@coveralls
Copy link

coveralls commented Jan 2, 2020 •
edited
Loading

Coverage Status

Coverage decreased (-0.007%) to 81.851% when pulling b8aa478 on murrayrm:doc_updates into ccbd7ac on python-control:master.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.4%) to 81.458% when pulling b8aa478 on murrayrm:doc_updates into ccbd7ac on python-control:master.

@murrayrm murrayrm added this to the 0.8.3 milestone Jan 3, 2020
@murrayrm murrayrm mentioned this pull request Jan 3, 2020
Closed
@murrayrm murrayrm merged commit ec8cbf0 into python-control:master Jan 4, 2020
@murrayrm murrayrm deleted the doc_updates branch January 4, 2020 06:11
repagh pushed a commit to repagh/python-control that referenced this pull request Jun 9, 2020
@murrayrm @repagh
Documentation updates (python-control#360)
6e0d70b 
* add info on methods for time responses
* add script and Jupyter notebook examples to documentation
* updated I/O systems documentation (with example)
* fix *args, *kwargs*  in freqplot docstrings to fix issue python-control#358
* update series() and paralle() docstrings to fix issue python-control#358
* fix docstring for phase_plot of fix issue python-control#358
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.8.3
Development

Successfully merging this pull request may close these issues.
2 participants
@murrayrm @coveralls