From 312bdbabb84cbef4b6384e377a97c3a67638d890 Mon Sep 17 00:00:00 2001
From: "McDonnell, Marshall T" <mcdonnellmt@ornl.gov>
Date: Mon, 7 May 2018 14:21:57 -0400
Subject: [PATCH] Fixed cpp and sphinx warnings
---
.../inc/MantidAlgorithms/CarpenterSampleCorrection.h | 2 +-
.../algorithms/CalculateCarpenterSampleCorrection-v1.rst | 2 +-
docs/source/algorithms/MayersSampleCorrection-v1.rst | 2 +-
docs/source/concepts/MultipleScattering.rst | 4 ++--
docs/source/release/v3.13.0/framework.rst | 4 ++--
5 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/Framework/Algorithms/inc/MantidAlgorithms/CarpenterSampleCorrection.h b/Framework/Algorithms/inc/MantidAlgorithms/CarpenterSampleCorrection.h
index 5cd32d316f3..64504e0fc1f 100644
--- a/Framework/Algorithms/inc/MantidAlgorithms/CarpenterSampleCorrection.h
+++ b/Framework/Algorithms/inc/MantidAlgorithms/CarpenterSampleCorrection.h
@@ -69,7 +69,7 @@ public:
}
// Algorithm's alias for identification overriding a virtual method
- const std::string alias() const {
+ const std::string alias() const override {
return "MultipleScatteringCylinderAbsorption";
}
diff --git a/docs/source/algorithms/CalculateCarpenterSampleCorrection-v1.rst b/docs/source/algorithms/CalculateCarpenterSampleCorrection-v1.rst
index a707dbb7d39..5a69ef609cb 100644
--- a/docs/source/algorithms/CalculateCarpenterSampleCorrection-v1.rst
+++ b/docs/source/algorithms/CalculateCarpenterSampleCorrection-v1.rst
@@ -42,7 +42,7 @@ This algorithm calculates and outputs the absorption and/or multiple scattering
2. The multiple scattering correction workspace will be OutputWorkspaceBaseName + `_ms` and will be in `.getItem(1)`.
-This is the child algorithm that :ref:`algm-CarpenterSampleCorrection` (also known as :ref:`algm-MultipleScatteringCylinderAbsorption`) uses to calculate and apply the correction to a sample workspace.
+This is the child algorithm that :ref:`algm-CarpenterSampleCorrection` (previously known as *MultipleScatteringCylinderAbsorption*) uses to calculate and apply the correction to a sample workspace.
Usage
-----
diff --git a/docs/source/algorithms/MayersSampleCorrection-v1.rst b/docs/source/algorithms/MayersSampleCorrection-v1.rst
index a2163c2834e..8afc8aab57a 100644
--- a/docs/source/algorithms/MayersSampleCorrection-v1.rst
+++ b/docs/source/algorithms/MayersSampleCorrection-v1.rst
@@ -97,7 +97,7 @@ References
.. [1] Lindley, E.J., & Mayers, J. Cywinski, R. (Ed.). (1988). Experimental method and corrections to data. United Kingdom: Adam Hilger. - https://inis.iaea.org/search/search.aspx?orig_q=RN:20000574
-.. seealso :: Algorithm :ref:`algm-MultipleScatteringCylinderAbsorption`
+.. seealso :: Algorithm :ref:`algm-CarpenterSampleCorrection`
.. categories::
diff --git a/docs/source/concepts/MultipleScattering.rst b/docs/source/concepts/MultipleScattering.rst
index 6f882289df4..f2457d79523 100644
--- a/docs/source/concepts/MultipleScattering.rst
+++ b/docs/source/concepts/MultipleScattering.rst
@@ -70,9 +70,9 @@ Mayers Sample Correction
------------------------
Documentation for this algorithm can found :ref:`here <algm-MayersSampleCorrection>`.
-Multiple Scattering Cylinder Absorption
+Carpenter Sample Correction
---------------------------------------
-This is a Carpenter style correction. For more details see :ref:`here <algm-MultipleScatteringCylinderAbsorption>`.
+This is a Carpenter style correction. For more details see :ref:`here <algm-CarpenterSampleCorrection>`.
References
~~~~~~~~~~
diff --git a/docs/source/release/v3.13.0/framework.rst b/docs/source/release/v3.13.0/framework.rst
index 21b37090023..4c068ffa485 100644
--- a/docs/source/release/v3.13.0/framework.rst
+++ b/docs/source/release/v3.13.0/framework.rst
@@ -28,9 +28,9 @@ New Algorithms
- :ref:`LoadSampleShape <algm-LoadSampleShape>` loads a shape into the sample in a workspace from an STL file,
which contains a list of triangles.
-- :ref:`CalculateCarpenterSampleCorrection` outputs a group workspace with the separate absorption and multiple scattering corrections for flexibility to the User to apply them to the sample workspace
+- :ref:`CalculateCarpenterSampleCorrection <algm-CalculateCarpenterSampleCorrection` outputs a group workspace with the separate absorption and multiple scattering corrections for flexibility to the User to apply them to the sample workspace
-- :ref:`CarpenterSampleCorrection` replaces :ref:`MultipleScatteringCylinderAbsorption` and uses :ref:`CalculateCarpenterSampleCorrection` for calculating its corrections.
+- :ref:`CarpenterSampleCorrection <algm-CarpenterSamlpeCorrection` replaces *MultipleScatteringCylinderAbsorption* and uses :ref:`CalculateCarpenterSampleCorrection <algm-CalculateCarpenterSampleCorrection` for calculating its corrections.
Improved
########
--
GitLab