Update documentation for the algorithms.

Refs #7309
mantidproject · Jul 26, 2013 · f07bacf · f07bacf
1 parent eac1866
commit f07bacf
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/RenameWorkspace.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/RenameWorkspace.h
@@ -15,6 +15,9 @@ namespace Algorithms
     The renaming is implemented as a removal of the original workspace from the data service
     and re-addition under the new name.
 
+    The algorithm will fail with an error if the name of OutputWorkspace already exists
+    in the ADS.
+
     Required Properties:
     <UL>
     <LI> InputWorkspace - The name of the Workspace to take as input </LI>

diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/RenameWorkspaces.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/RenameWorkspaces.h
@@ -15,11 +15,15 @@ namespace Algorithms
     The renaming is implemented as a removal of the original workspace from the data service
     and re-addition under the new name.
 
+    The algorithm will fail with an error if any of the OutputWorkspace names specified
+    (or constructed using Prefix of Suffix) do already exist in ADS.
+
     Required Properties:
     <UL>
     <LI> InputWorkspace - Comma sepatated list of names of the Workspace to take as input </LI>
-    <LI> OutputWorkspace - string to append or prefix of the names of the workspaces </LI>
-    <LI> Prefix - true if prefixing the Output Workspace name
+    <LI> OutputWorkspace - Comma separated list of new names </LI>
+    <LI> Prefix - String which will be added to the front of every InputWorkspace name </LI>
+    <LI> Suffix - String which will be added to the end of every InputWorkspace name </LI>
     </UL>
 
     Copyright &copy; 2007-2012 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory