From b042b5b38af6e2fe276b43a3f190d9cfb17625bf Mon Sep 17 00:00:00 2001
From: Jelle Teijema <j.j.teijema@gmail.com>
Date: Thu, 31 Oct 2024 10:27:32 +0100
Subject: [PATCH] update metrics loss docstring

Co-authored-by: Jonathan de Bruin <jonathandebruinos@gmail.com>
---
 asreviewcontrib/insights/metrics.py | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/asreviewcontrib/insights/metrics.py b/asreviewcontrib/insights/metrics.py
index 7346e7e..19b8f90 100644
--- a/asreviewcontrib/insights/metrics.py
+++ b/asreviewcontrib/insights/metrics.py
@@ -171,9 +171,7 @@ def _tnr(labels, intercept, x_absolute=False):
     return _slice_metric(x, y, intercept)
 
 def loss(state_obj, priors=False):
-    """
-    Computes a loss value that represents how far the recall curve is from
-    perfect recall.
+    """Compute the loss value.
 
     The function calculates a value based on the area over the recall curve and
     under the perfect recall (i.e., an impossible area for recall values).