Skip to content

Commit

Permalink
add suggested docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
braingram committed Dec 9, 2024
1 parent 7f48346 commit 800fd01
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion romancal/associations/skycell_asn.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,27 @@


def skycell_asn(filelist, output_file_root, product_type, release_product):
"""Create the skycell associaton from the list"""
"""
Create the skycell association from the list of files.
This function processes a list of files, identifies matching patches, generates
TAN WCS parameters, and creates an association file for the identified sky patches.
Parameters
----------
filelist : list of str
List of file names to be processed.
output_file_root : str
Root string for the output association file.
product_type : str
Type of product when creating the association (e.g., 'visit', 'daily').
release_product : str
Release product identifier for the association.
Returns
-------
None
"""
all_patches = []
file_list = []
for file_name in filelist:

Check warning on line 47 in romancal/associations/skycell_asn.py

View check run for this annotation

Codecov / codecov/patch

romancal/associations/skycell_asn.py#L47

Added line #L47 was not covered by tests
Expand Down

0 comments on commit 800fd01

Please sign in to comment.