CheckForSampleLogs documentation. Refs #9571

Code/Mantid/Framework/PythonInterface/plugins/algorithms/CheckForSampleLogs.py

@@ -24,7 +24,7 @@ def PyInit(self):
         """
 	self.declareProperty(WorkspaceProperty("Workspace", "",Direction.Input), "The workspace to check.")
 	self.declareProperty("LogNames","","Names of the logs to look for")	
-	self.declareProperty("Result","",Direction.Output)        
+	self.declareProperty("Result","A string that will be empty if all the logs are found, otherwise will contain an error message",Direction.Output)        
         return
 
     def PyExec(self):

Code/Mantid/docs/source/algorithms/CheckForSampleLogs-v1.rst

@@ -9,6 +9,36 @@
 Description
 -----------
 
-Check if the workspace has some given sample logs
+Check if the workspace has some given sample logs. An empty string will be returned if all the logs are found, otherwise the result is  an error message 
+
+
+Usage
+-----
+
+.. include:: ../usagedata-note.txt
+
+.. testcode:: CheckForSampleLogs
+
+    #load a workspace with logs
+    ws=Load("CNCS_7860")
+
+    sampleLogs="Phase1,Phase3"
+    result=CheckForSampleLogs(ws,sampleLogs)
+    if len(result)==0:
+        print "We found logs for "+sampleLogs
+    sampleLogs="DJIA"
+    result=CheckForSampleLogs(ws,sampleLogs)
+    print result
+
+.. testcleanup:: CheckForSampleLogs
+
+    DeleteWorkspace('ws')
+
+Output:
+
+.. testoutput:: CheckForSampleLogs
+
+    We found logs for Phase1,Phase3
+    Property DJIA not found
 
 .. categories::