diff --git a/Framework/Algorithms/src/AddSampleLog.cpp b/Framework/Algorithms/src/AddSampleLog.cpp index 4e78503a038ab665acad2f99b4b851c581d370c2..8664293db7ba3fa3649e86215142c7c9425098e1 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 5dc96389e1b9e05946da8e96932ccdee87b73b17..4f2c79311a924fb8dae2bdf8da43ee62949041cd 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::