Skip to content

Commit

Permalink
Comment cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Bryan Worrell committed Apr 2, 2021
1 parent bbf5bb5 commit 463944a
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions app/service/data_svc.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def _iter_data_files():
will begin with "data/".
Note:
This will skip any files starting with '.' (e.g., 'gitkeep').
This will skip any files starting with '.' (e.g., '.gitkeep').
"""
for data_glob in DATA_FILE_GLOBS:
for f in glob.glob(data_glob):
Expand All @@ -62,8 +62,9 @@ def _delete_directory_contents(path):
"""Delete all files and subdirectories under `path`.
Note:
This uses `glob` and thus, ignores files files that
start with a '.' (e.g., '.gitkeep')
This uses `glob` and thus, ignores top-level files
that start with a '.' (e.g., '.gitkeep'. Any subdirectories
are deleted entirely (even if they contain '.' files).
"""
if not os.path.exists(path):
return
Expand All @@ -81,9 +82,8 @@ def _delete_directory_contents(path):
async def destroy():
"""Clear the caldera data directory and server state.
This moves all data files and the object store to the specified
backup directory. The original data file paths are preserved
under the backup directory.
This moves all data files and the object store to the data backup directory.
The original data file paths are preserved under the backup directory.
Example (original path -> new backup path):
data/results/23deddf-ff3f2.yml -> backup/data/results/23deddf-ff3f2.yml
Expand Down

0 comments on commit 463944a

Please sign in to comment.