Skip to content
Snippets Groups Projects
Commit cd5d50cf authored by Joseph Ramsay's avatar Joseph Ramsay
Browse files

Re #20603 Added suffix to POLARIS docs

parent 9fe906bd
No related merge requests found
......@@ -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
......
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