From 6ea94cdaf4214c6bae3102d9a45bbf18e282523c Mon Sep 17 00:00:00 2001
From: Joseph Ramsay <joseph.ramsay@stfc.ac.uk>
Date: Mon, 30 Oct 2017 15:59:02 +0000
Subject: [PATCH] Re #20603 Added docstring for generate_vanadium_name
---
scripts/Diffraction/isis_powder/routines/common.py | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/scripts/Diffraction/isis_powder/routines/common.py b/scripts/Diffraction/isis_powder/routines/common.py
index a1413d8d092..60378e6b518 100644
--- a/scripts/Diffraction/isis_powder/routines/common.py
+++ b/scripts/Diffraction/isis_powder/routines/common.py
@@ -149,6 +149,12 @@ def generate_run_numbers(run_number_string):
def _generate_vanadium_name(vanadium_string, is_spline, *args):
+ """
+ :param vanadium_string: The number of the run being processed
+ :param is_spline: True if the workspace to save out is a spline
+ :param args: Any other strings to append to the filename
+ :return: A filename for the vanadium
+ """
out_name = 'Van'
if is_spline:
out_name += 'Splined'
--
GitLab