Skip to content

Commit 48d47b8

Browse files
committed
Changed name of parameter to download_dir
1 parent b7137d6 commit 48d47b8

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

astroquery/esasky/core.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ def query_region_catalogs(self, position, radius, catalogs=__ALL_STRING,
278278
return commons.TableList(query_result)
279279

280280
def get_maps(self, query_table_list, missions=__ALL_STRING,
281-
savename=__MAPS_STRING, cache=True):
281+
download_dir=__MAPS_STRING, cache=True):
282282
"""
283283
This method takes the dictionary of missions and metadata as returned by
284284
query_region_maps and downloads all maps to the selected folder.
@@ -296,7 +296,7 @@ def get_maps(self, query_table_list, missions=__ALL_STRING,
296296
Can be either a specific mission or a list of missions (all mission
297297
names are found in list_missions()) or 'all' to search in all
298298
missions. Defaults to 'all'.
299-
savename : string, optional
299+
download_dir : string, optional
300300
The folder where all downloaded maps should be stored.
301301
Defaults to a folder called 'Maps' in the current working directory.
302302
cache : bool, optional
@@ -339,11 +339,11 @@ def get_maps(self, query_table_list, missions=__ALL_STRING,
339339
self._get_maps_for_mission(
340340
sanitized_query_table_list[query_mission],
341341
query_mission,
342-
savename,
342+
download_dir,
343343
cache))
344344
break
345345
if (len(sanitized_query_table_list) > 0):
346-
log.info("Maps available at %s" %os.path.abspath(savename))
346+
log.info("Maps available at %s" %os.path.abspath(download_dir))
347347
else:
348348
print("No maps found")
349349
return maps

docs/esasky/esasky.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,12 +215,12 @@ dictionary where the used filter is the key and the HDUList is the value.
215215
}
216216
217217
Note that the fits files also are stored to disk. By default they are saved to
218-
the working directory but the location can be chosen by the savename
218+
the working directory but the location can be chosen by the download_dir
219219
parameter:
220220

221221
.. code-block:: python
222222
223-
>>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], savename="/home/user/esasky")
223+
>>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], download_dir="/home/user/esasky")
224224
225225
Get maps
226226
--------
@@ -232,13 +232,13 @@ it takes a `~astroquery.utils.TableList` instead of position, radius and mission
232232
.. code-block:: python
233233
234234
>>> table_list = ESASky.query_region_maps("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'])
235-
>>> images = ESASky.get_maps(table_list, savename="/home/user/esasky")
235+
>>> images = ESASky.get_maps(table_list, download_dir="/home/user/esasky")
236236
237237
This example is equivalent to:
238238

239239
.. code-block:: python
240240
241-
>>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], savename="/home/user/esasky")
241+
>>> images = ESASky.get_images("m51", radius="20 arcmin", missions=['Herschel', 'XMM-EPIC'], download_dir="/home/user/esasky")
242242
243243
244244
Reference/API

0 commit comments

Comments
 (0)