From 15ee4b4b9af66811dea1a30f628e08a0bc726d1a Mon Sep 17 00:00:00 2001
From: Pete Peterson <petersonpf@ornl.gov>
Date: Fri, 1 Dec 2017 10:51:20 -0500
Subject: [PATCH] Add links for return types
---
.../kernel/src/Exports/TimeSeriesProperty.cpp | 34 +++++++++++--------
1 file changed, 20 insertions(+), 14 deletions(-)
diff --git a/Framework/PythonInterface/mantid/kernel/src/Exports/TimeSeriesProperty.cpp b/Framework/PythonInterface/mantid/kernel/src/Exports/TimeSeriesProperty.cpp
index 7736d4c86c7..72b9fc79263 100644
--- a/Framework/PythonInterface/mantid/kernel/src/Exports/TimeSeriesProperty.cpp
+++ b/Framework/PythonInterface/mantid/kernel/src/Exports/TimeSeriesProperty.cpp
@@ -33,33 +33,39 @@ using Mantid::PythonInterface::Policies::VectorToNumpy;
#Prefix "TimeSeriesProperty", \
init<const std::string &>((arg("self"), arg("value")))) \
.add_property( \
- "value", \
- make_function( \
- &Mantid::Kernel::TimeSeriesProperty<TYPE>::valuesAsVector, \
- return_value_policy<VectorToNumpy>())) \
+ "value", \
+ make_function( \
+ &Mantid::Kernel::TimeSeriesProperty<TYPE>::valuesAsVector, \
+ return_value_policy<VectorToNumpy>())) \
.add_property("times", \
&Mantid::Kernel::TimeSeriesProperty<TYPE>::timesAsVector) \
- .def("addValue", (void (TimeSeriesProperty<TYPE>::*)( \
- const DateAndTime &, const TYPE)) & \
- TimeSeriesProperty<TYPE>::addValue, \
+ .def("addValue", \
+ (void (TimeSeriesProperty<TYPE>::*)(const DateAndTime &, \
+ const TYPE)) & \
+ TimeSeriesProperty<TYPE>::addValue, \
(arg("self"), arg("time"), arg("value"))) \
- .def("addValue", (void (TimeSeriesProperty<TYPE>::*)( \
- const std::string &, const TYPE)) & \
- TimeSeriesProperty<TYPE>::addValue, \
+ .def("addValue", \
+ (void (TimeSeriesProperty<TYPE>::*)(const std::string &, \
+ const TYPE)) & \
+ TimeSeriesProperty<TYPE>::addValue, \
(arg("self"), arg("time"), arg("value"))) \
.def("clear", &TimeSeriesProperty<TYPE>::clear, arg("self")) \
.def("valueAsString", &TimeSeriesProperty<TYPE>::value, arg("self")) \
.def("size", &TimeSeriesProperty<TYPE>::size, arg("self")) \
- .def("firstTime", &TimeSeriesProperty<TYPE>::firstTime, arg("self")) \
+ .def("firstTime", &TimeSeriesProperty<TYPE>::firstTime, arg("self"), \
+ "returns :class:`mantid.kernel.DateAndTime`") \
.def("firstValue", &TimeSeriesProperty<TYPE>::firstValue, arg("self")) \
- .def("lastTime", &TimeSeriesProperty<TYPE>::lastTime, arg("self")) \
+ .def("lastTime", &TimeSeriesProperty<TYPE>::lastTime, arg("self"), \
+ "returns :class:`mantid.kernel.DateAndTime`") \
.def("lastValue", &TimeSeriesProperty<TYPE>::lastValue, arg("self")) \
.def("nthValue", &TimeSeriesProperty<TYPE>::nthValue, \
(arg("self"), arg("index"))) \
.def("nthTime", &TimeSeriesProperty<TYPE>::nthTime, \
- (arg("self"), arg("index"))) \
+ (arg("self"), arg("index")), \
+ "returns :class:`mantid.kernel.DateAndTime`") \
.def("getStatistics", &TimeSeriesProperty<TYPE>::getStatistics, \
- arg("self")) \
+ arg("self"), \
+ "returns :class:`mantid.kernel.TimeSeriesPropertyStatistics`") \
.def("timeAverageValue", &TimeSeriesProperty<TYPE>::timeAverageValue, \
arg("self"));
}
--
GitLab