re #9590 done all of them

mantidproject · Jun 18, 2014 · 904768c · 904768c
1 parent da5133c
commit 904768c
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 0 deletions.
diff --git a/Code/Mantid/docs/source/algorithms/CreatePSDBleedMask-v1.rst b/Code/Mantid/docs/source/algorithms/CreatePSDBleedMask-v1.rst
@@ -20,6 +20,7 @@ Restrictions on the input workspace
 ###################################
 
 -  The workspace must contain either raw counts or counts/us.
+
 Usage
 -----
 

diff --git a/Code/Mantid/docs/source/algorithms/DetectorEfficiencyVariation-v1.rst b/Code/Mantid/docs/source/algorithms/DetectorEfficiencyVariation-v1.rst
@@ -35,4 +35,30 @@ Child algorithms used
 
 Uses the :ref:`algm-Integration` algorithm to sum the spectra.
 
+Usage
+-----
+
+**Example:**
+
+.. testcode:: ExDetEffVariation
+
+    import numpy as np
+
+    wsBase=CreateSampleWorkspace()    
+    ws=CreateSampleWorkspace()
+    noisyY =  np.array(ws.readY(0))
+    noisyY[0]=1e20
+    ws.setY(50,noisyY)
+
+    (wsOut, numFailures) = DetectorEfficiencyVariation(WhiteBeamBase='wsBase', WhiteBeamCompare='ws')
+
+    print "%i spectra has been masked in wsOut" % numFailures
+
+Output:
+
+.. testoutput:: ExDetEffVariation
+
+    1 spectra has been masked in wsOut
+
+
 .. categories::
diff --git a/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v1.rst b/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v1.rst
@@ -13,6 +13,8 @@ If the *Output* property is set, the beam center will be placed in a
 table workspace. Otherwise, the result is placed in an ArrayProperty
 named *CenterOfMass*.
 
+This algoirthm is not intended for use directly, it is part of the SNS SANS reduction workflow.
+
 See `SANS
 Reduction <http://www.mantidproject.org/Reduction_for_HFIR_SANS>`__
 documentation for details.

diff --git a/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v2.rst b/Code/Mantid/docs/source/algorithms/FindCenterOfMassPosition-v2.rst
@@ -13,6 +13,8 @@ If the *Output* property is set, the beam centre will be placed in a
 table workspace. Otherwise, the result is placed in an ArrayProperty
 named *CenterOfMass*.
 
+This algoirthm is not intended for use directly, it is part of the SNS SANS reduction workflow.
+
 See `SANS
 Reduction <http://www.mantidproject.org/Reduction_for_HFIR_SANS>`__
 documentation for details.