docstrings not needed for each sort key func (This would be overkill.)

Author: d-w-moore

irods/data_object.py

@@ -70,13 +70,13 @@ class _repl_status(enum.Enum):  # noqa: N801
 _REFERENCE_DATETIME = datetime.fromtimestamp(0, timezone.utc)
 
 
+# Key functions to dictate how replica row results will be sorted within an iRODSDataObject.
+
 def REPLICA_NUMBER_SORT_KEY_FN(row):  # noqa: N802
-    """Key function to sort replica results on replica number."""
     return row[DataObject.replica_number]
 
 
 def REPLICA_FITNESS_SORT_KEY_FN(row):  # noqa: N802
-    """Key function to sort replica results first on replica quality, then on age of modification timestamp ."""
     repl_status = int(row[DataObject.replica_status])
 
     repl_status_rank = _REPL_STATUSES.index(repl_status) if _REPL_STATUSES.count(repl_status) else sys.maxsize