Fix API doc of _ci_logmlog

sebp · Jan 12, 2025 · 28d7652 · 28d7652
1 parent 32f4bc0
commit 28d7652
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/sksurv/nonparametric.py b/sksurv/nonparametric.py
@@ -189,9 +189,13 @@ def _compute_counts_truncated(event, time_enter, time_exit):
 
 
 def _ci_logmlog(s, sigma_t, z):
-    """Compute the pointwise log-minus-log transformed confidence intervals.
+    r"""Compute the pointwise log-minus-log transformed confidence intervals.
     s refers to the prob_survival or the cum_inc (for the competing risks case).
-    sigma_t is the square root of the estimator of the log of the variance of s.
+    sigma_t is the square root of the variance of the log of the estimator of s.
+
+    .. math::
+
+        \sigma_t = \mathrm{Var}(\log(\hat{S}(t)))
     """
     eps = np.finfo(s.dtype).eps
     mask = s > eps