From a3accff8dbe8e623a58789df59fcc1707c70c117 Mon Sep 17 00:00:00 2001
From: Antti Soininen <soininen@ill.fr>
Date: Fri, 25 Jan 2019 12:30:00 +0100
Subject: [PATCH] Add Python API docs for RebinParamsValidator
---
.../kernel/src/Exports/RebinParamsValidator.cpp | 4 +++-
.../python/mantid/kernel/RebinParamsValidator.rst | 15 +++++++++++++++
2 files changed, 18 insertions(+), 1 deletion(-)
create mode 100644 docs/source/api/python/mantid/kernel/RebinParamsValidator.rst
diff --git a/Framework/PythonInterface/mantid/kernel/src/Exports/RebinParamsValidator.cpp b/Framework/PythonInterface/mantid/kernel/src/Exports/RebinParamsValidator.cpp
index 68f11dad61b..ba8f8e430a7 100644
--- 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
new file mode 100644
index 00000000000..16eac58b20a
--- /dev/null
+++ 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:
+
--
GitLab