From 6aa50a72a4ad3db303db6fd0df898050528a173f Mon Sep 17 00:00:00 2001
From: Jay Rainey <jawrainey@gmail.com>
Date: Thu, 5 Jun 2014 09:29:26 +0100
Subject: [PATCH] Add detailed description to CatalogDownloadDatafiles. Refs
#9585.
---
.../docs/source/algorithms/CatalogDownloadDataFiles-v1.rst | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/Code/Mantid/docs/source/algorithms/CatalogDownloadDataFiles-v1.rst b/Code/Mantid/docs/source/algorithms/CatalogDownloadDataFiles-v1.rst
index d00809997b6..3f21115aeb3 100644
--- a/Code/Mantid/docs/source/algorithms/CatalogDownloadDataFiles-v1.rst
+++ b/Code/Mantid/docs/source/algorithms/CatalogDownloadDataFiles-v1.rst
@@ -46,7 +46,11 @@ Output:
# This option will not append any file extensions to the datafiles.
CatalogDownloadDataFiles(FileIds = datafile_ids, # We now pass our list of ids here
- FileNames = datafile_ids, # and also here.
+ # The filenames are those that will be saved on your machine
+ # I have opted to use the datafile ids for this, but it is possible
+ # to provide a list of desired names.
+ # This must be the same size as the FileIds list.
+ FileNames = datafile_ids,
DownloadPath = '~/Desktop',
Session = session.getPropertyValue("Session")
)
--
GitLab