Merge pull request #114 from mtezzele/doc

mtezzele · web-flow · commit 49c8c1a09d85 · 2017-05-17T12:25:06.000+02:00
add docs files and typo
diff --git a/docs/source/_summaries/pygem.idw.IDW.perform.rst b/docs/source/_summaries/pygem.idw.IDW.perform.rst
@@ -0,0 +1,6 @@
+pygem\.idw\.IDW\.perform
+========================
+
+.. currentmodule:: pygem.idw
+
+.. automethod:: IDW.perform
diff --git a/docs/source/_summaries/pygem.params_idw.IDWParameters.__str__.rst b/docs/source/_summaries/pygem.params_idw.IDWParameters.__str__.rst
@@ -0,0 +1,6 @@
+pygem\.params\_idw\.IDWParameters\.\_\_str\_\_
+==============================================
+
+.. currentmodule:: pygem.params_idw
+
+.. automethod:: IDWParameters.__str__
diff --git a/docs/source/_summaries/pygem.params_idw.IDWParameters.read_parameters.rst b/docs/source/_summaries/pygem.params_idw.IDWParameters.read_parameters.rst
@@ -0,0 +1,6 @@
+pygem\.params\_idw\.IDWParameters\.read\_parameters
+===================================================
+
+.. currentmodule:: pygem.params_idw
+
+.. automethod:: IDWParameters.read_parameters
diff --git a/docs/source/_summaries/pygem.params_idw.IDWParameters.write_parameters.rst b/docs/source/_summaries/pygem.params_idw.IDWParameters.write_parameters.rst
@@ -0,0 +1,6 @@
+pygem\.params\_idw\.IDWParameters\.write\_parameters
+====================================================
+
+.. currentmodule:: pygem.params_idw
+
+.. automethod:: IDWParameters.write_parameters
diff --git a/pygem/params_idw.py b/pygem/params_idw.py
@@ -10,7 +10,7 @@ class IDWParameters(object):
 	Class that handles the Inverse Distance Weighting parameters in terms of
 	control points.
 
-	:cvar int p: the power parameter. The default value is 2.
+	:cvar int power: the power parameter. The default value is 2.
 	:cvar numpy.ndarray original_control_points: it is an
 		`n_control_points`-by-3 array with the coordinates of the original
 		interpolation control points before the deformation. The default is the
