Skip to content

Commit

Permalink
Update docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
kirkrodrigues committed Jun 28, 2024
1 parent 0529b37 commit bd7083f
Showing 1 changed file with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -306,13 +306,13 @@ def get_archive_and_file_split_ids(
msg_ix: int,
):
"""
Fetches the id of the file split id and the id of the archive containing
the file split based on the following criteria:
- 1. The file split's original file id = orig_file_id
- 2. The file split includes the message with index = msg_ix
Fetches the IDs of the file split and the archive containing the file split based on the
following criteria:
1. The file split's original file id = `orig_file_id`
2. The file split includes the message with index = `msg_ix`
:param db_conn:
:param orig_file_id: original file id of the split
:param msg_ix: message index the file split must include
:param orig_file_id: Original file id of the split
:param msg_ix: Index of the message that the file split must include
:return: A list of (archive id, file split id) on success. An empty list if
an exception occurs while interacting with the database.
"""
Expand Down

0 comments on commit bd7083f

Please sign in to comment.