[python-control-developers] [python-control/python-control] 262479: Update docstring for lqr

[Richard M. <mu...@cd...>]

  Branch: refs/heads/master
  Home:   https://github.com/python-control/python-control
  Commit: 262479061bcdaee2cc570c955ea0f96912030e88
      https://github.com/python-control/python-control/commit/262479061bcdaee2cc570c955ea0f96912030e88
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-18 (Sat, 18 Apr 2015)

  Changed paths:
    M control/statefbk.py

  Log Message:
  -----------
  Update docstring for lqr


  Commit: f498f0f2cb315836956f68e807c62abbad05ee4f
      https://github.com/python-control/python-control/commit/f498f0f2cb315836956f68e807c62abbad05ee4f
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-20 (Mon, 20 Apr 2015)

  Changed paths:
    M control/matlab.py
    M control/timeresp.py

  Log Message:
  -----------
  Update documentation about keyword args in lsim

Keyword arguments are no longer used in lsim (forced_response), or the
routines step_response, initial_response, impulse_response, because
forced_response no longer calls scipy.integrate.odeint


  Commit: fa439364b732f355d379573c4c9706aebf5cb82b
      https://github.com/python-control/python-control/commit/fa439364b732f355d379573c4c9706aebf5cb82b
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-20 (Mon, 20 Apr 2015)

  Changed paths:
    M .gitignore
    M control/__init__.py
    M control/matlab.py
    M control/timeresp.py
    M doc/Makefile
    R doc/analysis.rst
    R doc/bdalg_strings.rst
    R doc/class_strings.rst
    A doc/classes.rst
    M doc/conf.py
    A doc/control.rst
    R doc/creation.rst
    R doc/examples.rst
    R doc/freqplot.rst
    M doc/index.rst
    M doc/intro.rst
    A doc/matlab.rst
    R doc/matlab_strings.rst
    R doc/modsimp_strings.rst
    R doc/modules.rst
    R doc/synthesis.rst
    R doc/timeresp.rst
    R doc/utilities.rst

  Log Message:
  -----------
  Reorganize documentation

Previously, the modules were documented on separate pages (in the html
version), with one html page per module.  This commit changes the
organization of the documentation, so that there are concise tables of
functions (or classes), plus one html page per function or class.  This
is consistent with how numpy, scipy, and other projects handle their
documentation.


  Commit: 3f3c9f5547b0000ce710e2ba8a87d484b7d9acf1
      https://github.com/python-control/python-control/commit/3f3c9f5547b0000ce710e2ba8a87d484b7d9acf1
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-20 (Mon, 20 Apr 2015)

  Changed paths:
    M control/bdalg.py

  Log Message:
  -----------
  Fix minor documentation bugs in bdalg


  Commit: 20bd90a3f52ce554928f70244c72c7ce226cdd11
      https://github.com/python-control/python-control/commit/20bd90a3f52ce554928f70244c72c7ce226cdd11
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-20 (Mon, 20 Apr 2015)

  Changed paths:
    M control/canonical.py

  Log Message:
  -----------
  Improve documentation for canonical forms

Also makes `form` an optional argument for canonical_form, with
the default as reachable form (which is the only one implemented
so far).


  Commit: a5bfafcfd2e3a9b96204812d5ccada052ccf7b35
      https://github.com/python-control/python-control/commit/a5bfafcfd2e3a9b96204812d5ccada052ccf7b35
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-20 (Mon, 20 Apr 2015)

  Changed paths:
    M control/ctrlutil.py
    M control/frdata.py
    M control/freqplot.py
    M control/lti.py
    M control/margins.py
    M control/matlab.py
    M control/nichols.py
    M control/pzmap.py
    M control/rlocus.py
    M control/statefbk.py
    M control/statesp.py
    M control/tests/test_control_matlab.py
    M control/timeresp.py
    M control/xferfcn.py
    M doc/classes.rst

  Log Message:
  -----------
  Change Lti to LTI

This change is just cosmetic, and shouldn't affect any user code, since
the Lti base class is not exposed to the user.

(Well, technically it is exposed to the user, but it isn't in the
`control` namespace, isn't used in any tests, and probably shouldn't be
exposed to the user.)


  Commit: 2f90b031451632ce4febd29f96e8c757b4c3a34f
      https://github.com/python-control/python-control/commit/2f90b031451632ce4febd29f96e8c757b4c3a34f
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-20 (Mon, 20 Apr 2015)

  Changed paths:
    M control/frdata.py
    M control/matlab.py
    M control/statesp.py
    M control/xferfcn.py
    M doc/classes.rst

  Log Message:
  -----------
  Improve documentation for LTI system classes


  Commit: 56939a55dd65d77032e027ad68ec5a49f41faab6
      https://github.com/python-control/python-control/commit/56939a55dd65d77032e027ad68ec5a49f41faab6
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-20 (Mon, 20 Apr 2015)

  Changed paths:
    M control/matlab.py

  Log Message:
  -----------
  Provide better example system for margin docstring


  Commit: 01ff7ac593fa008b9f3129473b134a00ff489f57
      https://github.com/python-control/python-control/commit/01ff7ac593fa008b9f3129473b134a00ff489f57
  Author: Clancy Rowley <cwr...@pr...>
  Date:   2015-04-20 (Mon, 20 Apr 2015)

  Changed paths:
    M control/__init__.py
    M control/matlab.py
    M doc/control.rst

  Log Message:
  -----------
  Move documentation into doc/

The tables of functions/classes were previously defined in
control/__init__.py.  This commit moves those to doc/control.rst.  This
is consistent with what is done in scikit-learn, for example, and seems
cleaner to me, as most of the .rst is kept in the doc/ directory, rather
than the docstrings in __init__.py.  It also shortens a too-lengthy
docstring for the main `control` module.


  Commit: 58c7f85e38114732ee44f6910f1d135dda79be5d
      https://github.com/python-control/python-control/commit/58c7f85e38114732ee44f6910f1d135dda79be5d
  Author: Richard Murray <mu...@cd...>
  Date:   2015-04-26 (Sun, 26 Apr 2015)

  Changed paths:
    M .gitignore
    M control/__init__.py
    M control/bdalg.py
    M control/canonical.py
    M control/ctrlutil.py
    M control/frdata.py
    M control/freqplot.py
    M control/lti.py
    M control/margins.py
    M control/matlab.py
    M control/nichols.py
    M control/pzmap.py
    M control/rlocus.py
    M control/statefbk.py
    M control/statesp.py
    M control/tests/test_control_matlab.py
    M control/timeresp.py
    M control/xferfcn.py
    M doc/Makefile
    R doc/analysis.rst
    R doc/bdalg_strings.rst
    R doc/class_strings.rst
    A doc/classes.rst
    M doc/conf.py
    A doc/control.rst
    R doc/creation.rst
    R doc/examples.rst
    R doc/freqplot.rst
    M doc/index.rst
    M doc/intro.rst
    A doc/matlab.rst
    R doc/matlab_strings.rst
    R doc/modsimp_strings.rst
    R doc/modules.rst
    R doc/synthesis.rst
    R doc/timeresp.rst
    R doc/utilities.rst

  Log Message:
  -----------
  Merge pull request #60 from cwrowley/docs

Reorganize and improve documentation


Compare: https://github.com/python-control/python-control/compare/88a7d01f853e...58c7f85e3811