diff --git a/Framework/PythonInterface/plugins/algorithms/ExportGeometry.py b/Framework/PythonInterface/plugins/algorithms/ExportGeometry.py index aca44bbbd2136b978354554146d6e686dff117ec..5ccb96a507b608b867c2fbe7ebd5ece632d6cd82 100644 --- a/Framework/PythonInterface/plugins/algorithms/ExportGeometry.py +++ b/Framework/PythonInterface/plugins/algorithms/ExportGeometry.py @@ -53,7 +53,7 @@ class ExportGeometry(PythonAlgorithm): return "ExportGeometry" def summary(self): - return "Extract geometry into a variety of file formats" + return "Extract components from larger in-memory instrument, save as IDF style xml" def PyInit(self): self.declareProperty(WorkspaceProperty("InputWorkspace", "", @@ -67,7 +67,7 @@ class ExportGeometry(PythonAlgorithm): doc="Euler angles convention used when writing angles.") self.declareProperty(StringArrayProperty("Components", direction=Direction.Input), - doc="Comma separated list of instrument components to export") + doc="Comma separated list of instrument component names to export") self.declareProperty(FileProperty(name="Filename", defaultValue="", action=FileAction.Save, diff --git a/docs/source/algorithms/ExportGeometry-v1.rst b/docs/source/algorithms/ExportGeometry-v1.rst index 4f48153a878ebbfdb40377644f22b1be8403ce9e..36b20edabcd81c0ac8ffc73ebbafa54cce0be4e3 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 :ref:`Instrument Definition File <InstrumentDefinitionFile>` +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.