doc: clarify that asdict does not format values

fulcrumgenomics · Jun 4, 2024 · ad13758 · ad13758
1 parent fc6d2ba
commit ad13758
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/fgpyo/util/metric.py b/fgpyo/util/metric.py
@@ -386,6 +386,9 @@ def asdict(metric: Metric) -> Dict[str, Any]:
     """
     Convert a Metric instance to a dictionary.
 
+    No formatting is performed on the values, and they are returned as contained (and typed) in the
+    underlying dataclass. Use `Metric.format_value` to format the values to string.
+
     Args:
         metric: An instance of a Metric.