Modifications for release of 0.0.15

rlabbe · Jan 28, 2015 · 6067e85 · 6067e85
1 parent defd976
commit 6067e85
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 44 deletions.
diff --git a/docs/gh/GHFilter.rst b/docs/gh/GHFilter.rst
@@ -3,7 +3,6 @@ GHFilter
 
 Implements the g-h filter.
 
-
 -------
 
 .. automodule:: filterpy.gh

diff --git a/docs/gh/GHFilterOrder.rst b/docs/gh/GHFilterOrder.rst
@@ -1,11 +1,6 @@
 GHFilterOrder
 =============
 
-Introduction and Overview
--------------------------
-
-
--------
 
 .. automodule:: filterpy.gh
 

diff --git a/docs/gh/GHKFilter.rst b/docs/gh/GHKFilter.rst
@@ -1,12 +1,6 @@
 GHKFilter
 =========
 
-Introduction and Overview
--------------------------
-
-
--------
-
 .. automodule:: filterpy.gh
 
 .. autoclass:: GHKFilter

diff --git a/docs/gh/benedict_bornder_constants.rst b/docs/gh/benedict_bornder_constants.rst
@@ -1,11 +1,6 @@
 benedict_bornder_constants
 ==========================
 
-Introduction and Overview
--------------------------
-
-
-------
 
 .. automodule:: filterpy.gh
 

diff --git a/docs/gh/critical_damping_parameters.rst b/docs/gh/critical_damping_parameters.rst
@@ -1,12 +1,6 @@
 critical_damping_parameters
 ===========================
 
-Introduction and Overview
--------------------------
-
-
-------
-
 .. automodule:: filterpy.gh
 
 .. autofunction:: critical_damping_parameters
diff --git a/docs/gh/least_squares_parameters.rst b/docs/gh/least_squares_parameters.rst
@@ -1,11 +1,6 @@
 least_squares_parameters
 ========================
 
-Introduction and Overview
--------------------------
-
-
---------
 
 .. automodule:: filterpy.gh
 

diff --git a/docs/gh/optimal_noise_smoothing.rst b/docs/gh/optimal_noise_smoothing.rst
@@ -1,11 +1,6 @@
 optimal_noise_smoothing
 =======================
 
-Introduction and Overview
--------------------------
-
-
-------
 
 .. automodule:: filterpy.gh
 

diff --git a/docs/leastsq/LeastSquaresFilter.rst b/docs/leastsq/LeastSquaresFilter.rst
@@ -1,10 +1,6 @@
 LeastSquaresFilter
 ==================
 
-
------
-
-
 .. automodule:: filterpy.leastsq
 
 .. autoclass:: LeastSquaresFilter

diff --git a/filterpy/__init__.py b/filterpy/__init__.py
@@ -14,4 +14,4 @@
 for more information.
 """
 
-__version__ = "0.0.14"
+__version__ = "0.0.15"
diff --git a/filterpy/changelog.txt b/filterpy/changelog.txt
@@ -1,3 +1,9 @@
+Version 0.0.15
+==============
+
+A bunch of small changes and bug fixes. Documentation improvements.
+
+
 Version 0.0.14
 ==============
 

diff --git a/filterpy/common/helpers.py b/filterpy/common/helpers.py
@@ -36,13 +36,21 @@ def dotn(*args):
 
 def runge_kutta4(y, x, dx, f):
     """computes 4th order Runge-Kutta for dy/dx.
-    y is the initial value for y
-    x is the initial value for x
-    dx is the difference in x (e.g. the time step)
-    f is a callable function (y, x) that you supply to compute dy/dx for
-      the specified values.
+
+    **Parameters**
+
+    y : scalar
+        Initial/current value for y
+    x : scalar
+        Initial/current value for x
+    dx : scalar
+        difference in x (e.g. the time step)
+    f : ufunc(y,x)
+        Callable function (y, x) that you supply to compute dy/dx for
+        the specified values.
+
     """
-    
+
     k1 = dx * f(y, x)
     k2 = dx * f(y + 0.5*k1, x + 0.5*dx)
     k3 = dx * f(y + 0.5*k2, x + 0.5*dx)