From b50cef22f5eb3bfd8be6819192ffaa26c32974b8 Mon Sep 17 00:00:00 2001 From: Owen Arnold <owen.arnold@stfc.ac.uk> Date: Wed, 3 Oct 2018 08:30:07 +0100 Subject: [PATCH] Improve algorithm documentation --- docs/source/algorithms/ExportGeometry-v1.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/algorithms/ExportGeometry-v1.rst b/docs/source/algorithms/ExportGeometry-v1.rst index 4f48153a878..79841f26908 100644 --- a/docs/source/algorithms/ExportGeometry-v1.rst +++ b/docs/source/algorithms/ExportGeometry-v1.rst @@ -11,8 +11,11 @@ Description ----------- This algorithm is intended to write out portions of an instrument's -geometry. The resulting file is mean to be copied by-hand into a -geometry file. The main use of this is if the instrument geometry is +geometry in the instrument definition file xml format. The resulting +file is meant to be copied by-hand into a geometry file, the output +is not a useable IDF as written. + +The main use of this algorithm is if the instrument geometry is calibrated in mantid, this algorithm can be used to help get the information back into the initial instrument definition file. -- GitLab