diff --git a/docs/source/techniques/ISISPowder-Polaris-v1.rst b/docs/source/techniques/ISISPowder-Polaris-v1.rst index 7aa90850adbaf06e9eb6c83ac66b399a5fed4086..b2fd8f3728b4323895a774a2c66ff38f75749d13 100644 --- a/docs/source/techniques/ISISPowder-Polaris-v1.rst +++ b/docs/source/techniques/ISISPowder-Polaris-v1.rst @@ -117,6 +117,7 @@ above: The following parameters may also be optionally set: - :ref:`file_ext_polaris_isis-powder-diffraction-ref` +- :ref:`suffix_polaris_isis-powder-diffraction-ref` Example @@ -515,6 +516,21 @@ Example Input: # Or a range of numbers polaris_example.focus(sample_empty="100-110", ...) +.. _suffix_polaris_isis-powder-diffraction-ref: + +suffix +^^^^^^ +*Optional* + +This parameter specifies a suffix to append the names of output files +during a focus. + +Example Input: + +.. code-block:: python + + polaris_example.focus(suffix="-corr", ...) + .. _user_name_polaris_isis-powder-diffraction-ref: user_name