Merge pull request #24605 from mantidproject/RebinParamsValidator_api…

…_docs Add Python API docs for RebinParamsValidator
mantidproject · Jan 28, 2019 · 12bf030 · 12bf030
2 parents a2535a6 + a3accff
commit 12bf030
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/Framework/PythonInterface/mantid/kernel/src/Exports/RebinParamsValidator.cpp b/Framework/PythonInterface/mantid/kernel/src/Exports/RebinParamsValidator.cpp
@@ -26,5 +26,7 @@ void export_RebinParamsValidator() {
       .def("__init__",
            make_constructor(
                &createRebinParamsValidator, default_call_policies(),
-               (arg("AllowEmpty") = false, arg("AllowRange") = false)));
+               (arg("AllowEmpty") = false, arg("AllowRange") = false)),
+           "Constructs a validator verifying that the given float array is "
+           "valid sequence of rebinning parameters.");
 }
diff --git a/docs/source/api/python/mantid/kernel/RebinParamsValidator.rst b/docs/source/api/python/mantid/kernel/RebinParamsValidator.rst
@@ -0,0 +1,15 @@
+======================
+ RebinParamsValidator
+======================
+
+This is a Python binding to the C++ class Mantid::Kernel::RebinParamsValidator.
+
+*bases:* :py:obj:`mantid.kernel.IValidator`
+
+.. module:`mantid.kernel`
+
+.. autoclass:: mantid.kernel.RebinParamsValidator 
+    :members:
+    :undoc-members:
+    :inherited-members:
+