Skip to content

Commit 5888ff6

Browse files
author
Julie Imig
committed
addressing review comments
1 parent f497e7f commit 5888ff6

3 files changed

Lines changed: 7 additions & 3 deletions

File tree

TUTORIAL/tutorial_readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ The output message will report that this command only checked 2 files, but both
166166

167167
### Step 4e. Exporting results to alternate format
168168

169-
If you're not used to working with SQLite `.db` files, you can also save the output to an alternate format using the `--output_format` flag. Currently supported values include "csv", "fits", "html", and "excel".
169+
If you're not used to working with SQLite `.db` files, you can also save the output to an alternate format using the `--output_format` flag. Currently supported values include "csv", "fits", "html", and "excel". The `.db` file is always written by default, but this option will write an additional file in the chosen format.
170170

171171
For example, this command will save out a html file with the filename checker results in a color-coded table:
172172

mast_contributor_tools/filename_check/fc_app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ def check_filenames(hlsp_name: str, file_list: list[Path], dbFile: str, output_f
159159

160160
# Write ouput to alternate format if specified
161161
if output_format != "db":
162-
logger.debug(f"Writing to alternate format '{output_format}'")
162+
logger.debug(f"Also writing to alternate format '{output_format}'")
163163
ouput_files = db.write_to_alternate_format(output_format)
164164
logger.critical(f"Written to {ouput_files}")
165165

mast_contributor_tools/filename_check/fc_db.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,18 @@ def print_summary(self) -> str:
138138

139139
return summary_message
140140

141-
def write_to_alternate_format(self, save_format: str) -> None:
141+
def write_to_alternate_format(self, save_format: str) -> list[str]:
142142
"""
143143
Write out the SQLite DB as an alternate format.
144144
145145
Parameters
146146
----------
147147
save_format : str
148148
Format to save output: 'csv', 'excel', 'html', or 'fits'
149+
150+
Returns
151+
--------
152+
files_written: list[str]: List of file names written out
149153
"""
150154
# Check that input is a valid option
151155
supported_formats = ["csv", "excel", "fits", "html"]

0 commit comments

Comments
 (0)