Skip to content
Snippets Groups Projects
Commit 312bdbab authored by McDonnell, Marshall's avatar McDonnell, Marshall
Browse files

Fixed cpp and sphinx warnings

parent 29d735e5
No related branches found
No related tags found
No related merge requests found
......@@ -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";
}
......
......@@ -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
-----
......
......@@ -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::
......
......@@ -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
~~~~~~~~~~
......
......@@ -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
########
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment