Update the documentation. Re #2250.

mantidproject · Jun 7, 2018 · 9b89514 · 9b89514
1 parent c5bca82
commit 9b89514
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/Framework/DataHandling/inc/MantidDataHandling/ExtractPolarizationEfficiencies.h b/Framework/DataHandling/inc/MantidDataHandling/ExtractPolarizationEfficiencies.h
@@ -36,7 +36,7 @@ class DLLExport ExtractPolarizationEfficiencies : public API::Algorithm {
   const std::string name() const override;
   int version() const override;
   const std::vector<std::string> seeAlso() const override {
-    return {"PolarizationEfficienciCor"};
+    return {"PolarizationEfficiencyCor"};
   }
   const std::string category() const override;
   const std::string summary() const override;

diff --git a/docs/source/algorithms/ExtractPolarizationEfficiencies-v1.rst b/docs/source/algorithms/ExtractPolarizationEfficiencies-v1.rst
@@ -12,11 +12,12 @@ Description
 This algorithm reads polarization correction parameters from the intruments parameters file and creates an efficiency workspace ready to be used with :ref:`algm-PolarizationEfficiencyCor`. It is intended to be used as a child algorithm by the reflectometry
 reduction algorithms and not to be used directly.
 
-To work with this algorithm the parameters file must contain the following parameters (all of type `string`):
+To work with this algorithm the parameters file must contain the following parameters (all of type `string` and in the scope of the instrument):
 
 1. `polarization_correction_method` to specify the method of correction. Possible values are `Fredrikze` and `Wildes`.
-2. `efficiency_lambda` is a vector of wavelengths at which the efficiencies are sampled.
-3. A set of four parameters for each of the four efficiencies stored as vectors of values at the wavelengths in `efficiency_lambda`. The names of the parameters are different for the two methods of correction: `Pp`, `Ap`, `Rho` and `Alpha` for `Fredrikze` and `P1`, `P2`, `F1` and `F2` for `Wildes`.
+2. `polarization_correction_option` to specify the additional property of the correction algorithm. For `Fredrikze` the possible values are those of the `PolarizationAnalysis` property. For `Wildes` they are the values of the `Flippers` property.
+3. `efficiency_lambda` is a vector of wavelengths at which the efficiencies are sampled.
+4. A set of four parameters for each of the four efficiencies stored as vectors of values at the wavelengths in `efficiency_lambda`. The names of the parameters are different for the two methods of correction: `Pp`, `Ap`, `Rho` and `Alpha` for `Fredrikze` and `P1`, `P2`, `F1` and `F2` for `Wildes`.
 
 The values in the vector parameters must be separated by spaces, for example: