Add usage to CatalogGetDataSets. Refs #9585.

mantidproject · Jun 5, 2014 · e6768d6 · e6768d6
1 parent 1d5a1b2
commit e6768d6
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 10 deletions.
diff --git a/Code/Mantid/Framework/ICat/inc/MantidICat/CatalogGetDataFiles.h b/Code/Mantid/Framework/ICat/inc/MantidICat/CatalogGetDataFiles.h
@@ -52,7 +52,7 @@ namespace Mantid
       /// Algorithm's name for identification overriding a virtual method
       virtual const std::string name() const { return "CatalogGetDataFiles"; }
       ///Summary of algorithms purpose
-      virtual const std::string summary() const { return "Obtains inforamtion of the files associated to a specific investigation."; }
+      virtual const std::string summary() const { return "Obtains information of the datafiles associated to a specific investigation."; }
       /// Algorithm's version for identification overriding a virtual method
       virtual int version() const { return 1; }
       /// Algorithm's category for identification overriding a virtual method

diff --git a/Code/Mantid/Framework/ICat/inc/MantidICat/CatalogGetDataSets.h b/Code/Mantid/Framework/ICat/inc/MantidICat/CatalogGetDataSets.h
@@ -48,19 +48,16 @@ namespace Mantid
       CatalogGetDataSets():API::Algorithm(){}
       /// destructor for CatalogGetDataSets
       ~CatalogGetDataSets(){}
-
       /// Algorithm's name for identification overriding a virtual method
       virtual const std::string name() const { return "CatalogGetDataSets"; }
-    ///Summary of algorithms purpose
-    virtual const std::string summary() const {return "Gets the datasets associated to the selected investigation.";}
-
+      ///Summary of algorithms purpose
+      virtual const std::string summary() const { return "Obtains information of the datasets associated to a specific investigation."; }
       /// Algorithm's version for identification overriding a virtual method
       virtual int version() const { return 1; }
       /// Algorithm's category for identification overriding a virtual method
       virtual const std::string category() const { return "DataHandling\\Catalog"; }
 
     private:
-
       /// Overwrites Algorithm init method.
       void init();
       /// Overwrites Algorithm exec method

diff --git a/Code/Mantid/docs/source/algorithms/CatalogGetDataFiles-v1.rst b/Code/Mantid/docs/source/algorithms/CatalogGetDataFiles-v1.rst
@@ -9,7 +9,7 @@
 Description
 -----------
 
-This algorithm retrieves the information of the files associated to an investigation, and saves the results to a workspace.
+This algorithm retrieves the information of the datafiles associated to an investigation, and saves the results to a workspace.
 
 Usage
 -----

diff --git a/Code/Mantid/docs/source/algorithms/CatalogGetDataSets-v1.rst b/Code/Mantid/docs/source/algorithms/CatalogGetDataSets-v1.rst
@@ -9,8 +9,26 @@
 Description
 -----------
 
-This algorithm retrieves the datasets associated to the selected
-investigation from the information catalog and saves the search results
-to mantid workspace.
+This algorithm retrieves the information of the datasets associated to an investigation, and saves the results to a workspace.
+
+Usage
+-----
+
+**Example - obtain the datasets for a given catalog investigation.**
+
+.. code:: python
+
+    # Assumes you have logged in and stored the session information that is
+    # returned from CatalogLogin() inside the session variable.
+    datasets = CatalogGetDataSets(InvestigationId = '1193002', Session = session.getPropertyValue("Session"))
+
+    # Verify that we have any datafiles in the returned workspace.
+    print "The number of datasets for this investigation is: " + str(len(datasets))
+
+Output:
+
+.. code:: python
+
+    The number of datafiles in this investigation is: 2
 
 .. categories::