refs #5532. Wiki docs

mantidproject · Aug 3, 2012 · b176d69 · b176d69
1 parent 3490589
commit b176d69
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/Code/Mantid/Framework/PythonAPI/PythonAlgorithms/Stitch1D.py b/Code/Mantid/Framework/PythonAPI/PythonAlgorithms/Stitch1D.py
@@ -1,8 +1,13 @@
 """*WIKI* 
 
-Performs 1D stitching of Reflectometry 2D MDHistoWorkspaces.
+Performs 1D stitching of Reflectometry 2D MDHistoWorkspaces. Based on the Quick script developed at ISIS. This only works on 1D Histogrammed MD Workspaces.
+
+Scales either the LHS or RHS workspace by some scale factor which, can be manually specified, or calculated from the overlap.
+
+Calculates the weighted mean values in the overlap region and then combines the overlap region with the difference of the LHS and RHS workspaces
+
+*WIKI*"""
 
-"""
 import mantid.simpleapi as api
 
 from mantid.api import *