Skip to content

Commit 0b4d29e

Browse files
committed
Update docstrings for new zip filename format
1 parent 10fc515 commit 0b4d29e

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

astrocut/asdf_cutout.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ def write_as_zip(self, output_dir: Union[str, Path] = '.', filename: Union[str,
528528
Directory where the zip will be created. Default '.'.
529529
filename : str | Path | None, optional
530530
Name (or path) of the output zip file. If not provided, defaults to
531-
'cutouts_{YYYYmmdd_HHMMSS}.zip'. If provided without a '.zip' suffix,
531+
'astrocut_{ra}_{dec}_{size}.zip'. If provided without a '.zip' suffix,
532532
the suffix is added automatically.
533533
output_format : str, optional
534534
Either '.asdf' (default) or '.fits'. Determines which in-memory representation is zipped.

astrocut/cutout.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ def cutout(self):
153153
"""
154154
raise NotImplementedError('Subclasses must implement this method.')
155155

156-
def _make_cutout_filename(self, file_stem: str = None) -> str:
156+
def _make_cutout_filename(self, file_stem: str) -> str:
157157
"""
158158
Create a cutout filename based on a file stem, coordinates, and cutout size.
159159
@@ -220,7 +220,7 @@ def _write_cutouts_to_zip(
220220
Directory where the zip will be created. Default '.'
221221
filename : str | Path | None, optional
222222
Name (or path) of the output zip file. If not provided, defaults to
223-
'cutouts_{YYYYmmdd_HHMMSS}.zip'. If provided without a '.zip' suffix,
223+
'astrocut_{ra}_{dec}_{size}.zip'. If provided without a '.zip' suffix,
224224
the suffix is added automatically.
225225
build_entries : callable -> iterable of (arcname, payload), optional
226226
Function that yields entries lazily. Useful to build streams on demand.

astrocut/fits_cutout.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ def write_as_zip(self, output_dir: Union[str, Path] = '.', filename: Union[str,
440440
Directory where the zip will be created. Default '.'.
441441
filename : str | Path | None, optional
442442
Name (or path) of the output zip file. If not provided, defaults to
443-
'cutouts_{YYYYmmdd_HHMMSS}.zip'. If provided without a '.zip' suffix,
443+
'astrocut_{ra}_{dec}_{size}.zip'. If provided without a '.zip' suffix,
444444
the suffix is added automatically.
445445
446446
Returns

astrocut/tess_cube_cutout.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ def write_as_zip(self, output_dir: Union[str, Path] = '.', filename: Union[str,
520520
Directory where the zip will be created. Default '.'.
521521
filename : str | Path | None, optional
522522
Name (or path) of the output zip file. If not provided, defaults to
523-
'cutouts_{YYYYmmdd_HHMMSS}.zip'. If provided without a '.zip' suffix,
523+
'astrocut_{ra}_{dec}_{size}.zip'. If provided without a '.zip' suffix,
524524
the suffix is added automatically.
525525
526526
Returns

astrocut/tess_footprint_cutout.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ def write_as_zip(self, output_dir: Union[str, Path] = '.', filename: Union[str,
160160
Directory where the TPFs are written and where the zip will be created. Default '.'.
161161
filename : str | Path | None, optional
162162
Name (or path) of the output zip file. If not provided, defaults to
163-
'cutouts_{YYYYmmdd_HHMMSS}.zip'. If provided without a '.zip' suffix,
163+
'astrocut_{ra}_{dec}_{size}.zip'. If provided without a '.zip' suffix,
164164
the suffix is added automatically.
165165
166166
Returns

0 commit comments

Comments
 (0)