Add docstrings

puzzle-herrings · Jan 4, 2025 · 3ace1f7 · 3ace1f7
1 parent 07dcf68
commit 3ace1f7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/scripts/upload_asset.py b/scripts/upload_asset.py
@@ -21,6 +21,8 @@ def main(
     skip_confirmation: Annotated[bool, typer.Option("-y")] = False,
     dryrun: bool = False,
 ):
+    """Upload files to an S3-compatible object storage with proper CacheControl header."""
+
     output_path = PurePosixPath(output_path)
     assert not output_path.is_absolute(), "output_path must be a relative path"
 

diff --git a/scripts/upload_puzzle_pdf.py b/scripts/upload_puzzle_pdf.py
@@ -15,6 +15,7 @@
 
 
 def main(input_file: Path, solution: bool = False, dryrun: bool = False):
+    """Upload puzzle PDFs to an S3-compatible object storage with proper CacheControl header."""
     content = input_file.read_bytes()
     md5sum = md5(content)
     xxh32sum = xxh32(content)