From 3c28a9c9ad6148f62246363ea2298d1431601240 Mon Sep 17 00:00:00 2001 From: Anton Piccardo-Selg <anton.piccardo-selg@tessella.com> Date: Fri, 7 Aug 2015 13:12:07 +0100 Subject: [PATCH] Refs #13213 Add method description for guide method --- .../Algorithms/src/SANSCollimationLengthEstimator.cpp | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Code/Mantid/Framework/Algorithms/src/SANSCollimationLengthEstimator.cpp b/Code/Mantid/Framework/Algorithms/src/SANSCollimationLengthEstimator.cpp index bf318676a13..8f85b822d70 100644 --- a/Code/Mantid/Framework/Algorithms/src/SANSCollimationLengthEstimator.cpp +++ b/Code/Mantid/Framework/Algorithms/src/SANSCollimationLengthEstimator.cpp @@ -58,7 +58,9 @@ double SANSCollimationLengthEstimator::provideCollimationLength(Mantid::API::Mat /** - * This extraction strategy gets applied when guides are + * This extraction strategy gets applied when guides are used to calculate the collimation length. The instrument + * parameter file contains the information about the number of guides to use. The guide data itself is fetched + * from the sample logs. * @param inOutWS: a matrix workspace * @param L1: the distance between sample and source * @param collimationLengthCorrection: The correction to get the collimation length -- GitLab