From d09c500afe01569378982a786f93c63556124dfd Mon Sep 17 00:00:00 2001
From: Matthew D Jones <matthew.d.jones@tessella.com>
Date: Fri, 30 Oct 2015 10:07:46 +0000
Subject: [PATCH] Re #14178 Updated documentation
---
Framework/Algorithms/src/AddSampleLog.cpp | 4 ++--
docs/source/algorithms/AddSampleLog-v1.rst | 7 ++++++-
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/Framework/Algorithms/src/AddSampleLog.cpp b/Framework/Algorithms/src/AddSampleLog.cpp
index 4e78503a038..8664293db7b 100644
--- a/Framework/Algorithms/src/AddSampleLog.cpp
+++ b/Framework/Algorithms/src/AddSampleLog.cpp
@@ -44,8 +44,8 @@ void AddSampleLog::init() {
typeOptions.push_back("");
declareProperty("NumberType", "",
boost::make_shared<StringListValidator>(typeOptions),
- "Force LogText to be interpreted as a number of type \"int\" "
- "or \"double\".");
+ "Force LogText to be interpreted as a number of type 'int' "
+ "or 'double'.");
}
void AddSampleLog::exec() {
diff --git a/docs/source/algorithms/AddSampleLog-v1.rst b/docs/source/algorithms/AddSampleLog-v1.rst
index 5dc96389e1b..4f2c79311a9 100644
--- a/docs/source/algorithms/AddSampleLog-v1.rst
+++ b/docs/source/algorithms/AddSampleLog-v1.rst
@@ -21,6 +21,11 @@ If the LogText contains a numeric value, the created log will be of
integer type if an integer is passed and floating point (double)
otherwise. This applies to both the Number & Number Series options.
+The algorithm can be forced to create a log of integer or floating point
+type by using the optional NumberType property as 'Int' or 'Double'. For
+example, with NumberType='Double' the log for LogText='12' would be
+created as a floating point (double) rather than an integer.
+
To add logs that vary over time (Time Series Logs) use :ref:`algm-AddTimeSeriesLog`.
Usage
@@ -60,4 +65,4 @@ Output:
.. categories::
-.. sourcelink::
\ No newline at end of file
+.. sourcelink::
--
GitLab