Unverified Commit 6b118829 authored by Antti Soininen's avatar Antti Soininen Committed by GitHub
Browse files

Merge pull request #23698 from mantidproject/export_geometry_doc_fixes

Export geometry doc fixes
parents 742e6429 fd0552c8
......@@ -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,
......
......@@ -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.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment