diff --git a/docs/source/algorithms/CorrectTOFAxis-v1.rst b/docs/source/algorithms/CorrectTOFAxis-v1.rst index d29180bc571d4d9efdb02f3415445c170f5108cc..d4bacaf15e29cc8e3d160b379b01f47e6ebb5bab 100644 --- a/docs/source/algorithms/CorrectTOFAxis-v1.rst +++ b/docs/source/algorithms/CorrectTOFAxis-v1.rst @@ -37,7 +37,7 @@ Usage **Example - CorrectTOFAxis by specifying the elastic bin and L2** -.. textCode:: ExElasticBinWithL2 +.. testCode:: ExElasticBinWithL2 from mantid.kernel import DeltaEModeType, UnitConversion diff --git a/docs/source/algorithms/CylinderPaalmanPingsCorrection-v2.rst b/docs/source/algorithms/CylinderPaalmanPingsCorrection-v2.rst index 3404c0843f2d589f601f33a01e7e6a9aa092f5ce..8ac4a28bd38ca0e31809f7dd75c766efb94c2543 100644 --- a/docs/source/algorithms/CylinderPaalmanPingsCorrection-v2.rst +++ b/docs/source/algorithms/CylinderPaalmanPingsCorrection-v2.rst @@ -34,6 +34,7 @@ wavelengths are defined as follows: - **Indirect** : :math:`\lambda_1 = \lambda_{step}, \lambda_2 = \lambda_{fixed}` - **Efixed** : :math:`\lambda_1 = \lambda_2 = \lambda_{fixed}`, + where :math:`\lambda_{fixed}` is computed from the `Efixed` value corresponding to the monochromator or the analyser, and :math:`\lambda_{step}` iterates equidistantly over the wavelength points in the input workspace x-axis, controlled by `NumberWavelengths` property. diff --git a/docs/source/algorithms/FlatPlatePaalmanPingsCorrection-v1.rst b/docs/source/algorithms/FlatPlatePaalmanPingsCorrection-v1.rst index 14a7dfc456054969ffb1704af1207ca6bceea52b..ea6cf6bcc3aa629bcc0954ccc93a10ae70f1475e 100644 --- a/docs/source/algorithms/FlatPlatePaalmanPingsCorrection-v1.rst +++ b/docs/source/algorithms/FlatPlatePaalmanPingsCorrection-v1.rst @@ -30,8 +30,8 @@ Efixed mode ########### - In **Efixed** mode, the correction will be computed for a single wavelength number derived from the analyser or monochromator energy, -which by default will be attempted to be read from the instrument parameters (named **Efixed**), but can also be overridden in the **Efixed** input property. -In this case, the `NumberWavelengths` and `Interpolate` options will be ignored. + which by default will be attempted to be read from the instrument parameters (named **Efixed**), but can also be overridden in the **Efixed** input property. + In this case, the `NumberWavelengths` and `Interpolate` options will be ignored. Workflow -------- diff --git a/docs/source/api/python/techniques/ISISPowder-Polaris-v1.rst b/docs/source/api/python/techniques/ISISPowder-Polaris-v1.rst index 5a060373c686cb77767fe05f6dddd34b09398078..168d1e6c4c4c855e47aa12d451169e17d72b2419 100644 --- a/docs/source/api/python/techniques/ISISPowder-Polaris-v1.rst +++ b/docs/source/api/python/techniques/ISISPowder-Polaris-v1.rst @@ -1,8 +1,8 @@ .. _isis-powder-diffraction-polaris-ref: -======================================= +========================================= ISIS Powder Diffraction Scripts - Polaris -======================================= +========================================= .. warning:: These scripts and documentation are still undergoing active development. They can change in any way during these stages and the validity of all diff --git a/docs/source/api/python/techniques/ISISPowder-v1.rst b/docs/source/api/python/techniques/ISISPowder-v1.rst index 6fab89440c713a263ae229d3509e8d7e01e58a5f..0aca4291fe7f3b11d6a4b3a13ecee6b1ddde9a4e 100644 --- a/docs/source/api/python/techniques/ISISPowder-v1.rst +++ b/docs/source/api/python/techniques/ISISPowder-v1.rst @@ -14,6 +14,7 @@ ISIS Powder Diffraction Scripts Instrument Specific Documentation --------------------------------- + - :ref:`isis-powder-diffraction-pearl-ref` - :ref:`isis-powder-diffraction-polaris-ref` diff --git a/docs/source/interfaces/Indirect_Corrections.rst b/docs/source/interfaces/Indirect_Corrections.rst index 5759c11f2ecbe17210c26800cb9636bb55912dce..4e8efd538841269afa8a4c240c689edb4444b16e 100644 --- a/docs/source/interfaces/Indirect_Corrections.rst +++ b/docs/source/interfaces/Indirect_Corrections.rst @@ -87,7 +87,7 @@ Emode For flat plate, all the options except *Efixed*, are equivalent. In brief, use *Indirect* for QENS, *Efixed* for FWS and diffraction. *Efixed* can be used for QENS also, if the energy transfer can be neglected compared to the incident energy. - See :ref:`CylinderPaalmanPingsCorrections <algm-CylinderPaalmanPingsCorrections>` for the details. + See :ref:`CylinderPaalmanPingsCorrections <algm-CylinderPaalmanPingsCorrection>` for the details. Efixed The value of the incident (indirect) or final (direct) energy in `mev`. Specified in the instrument parameter file. diff --git a/docs/source/release/v3.10.0/indirect_inelastic.rst b/docs/source/release/v3.10.0/indirect_inelastic.rst index 7a12fc57d3e9da77aaf5311bff7afb1afa3c5679..33577664826969636183d30c6874eaa96791024c 100644 --- a/docs/source/release/v3.10.0/indirect_inelastic.rst +++ b/docs/source/release/v3.10.0/indirect_inelastic.rst @@ -33,8 +33,10 @@ ConvFit ~~~~~~~ * All FABADA minimizer options are now accessible from the function browser. + - The Delta Function option can now be used with StretchedExpFT mode + Jump Fit ~~~~~~~~ diff --git a/docs/source/release/v3.10.0/reflectometry.rst b/docs/source/release/v3.10.0/reflectometry.rst index 1a8015063d2d33fba75cc1b1740aed3feff36171..ca6c83ad6446ddb1db3e42e18c20d6e8f70c4354 100644 --- a/docs/source/release/v3.10.0/reflectometry.rst +++ b/docs/source/release/v3.10.0/reflectometry.rst @@ -8,9 +8,10 @@ Reflectometry Changes Algorithms ---------- -* :ref:`algm-SpecularReflectionPositionCorrect2 <algm-SpecularReflectionPositionCorrect2> - fixed a bug where entering +- :ref:`algm-SpecularReflectionPositionCorrect` - fixed a bug where entering an invalid detector or sample name would cause a segmentation fault. -* The :ref:`algm-SpecularReflectionPositionCorrect` algorithm has a new property, ``DetectorCorrectionType``, which specifies whether detector positions should be corrected by a vertical shift (default) or by a rotation around the sample position. +- The :ref:`algm-SpecularReflectionPositionCorrect` algorithm has a new property, ``DetectorCorrectionType``, + which specifies whether detector positions should be corrected by a vertical shift (default) or by a rotation around the sample position. ConvertToReflectometryQ -----------------------