From 907934ffb08542848d7ed95f4aceea5055507f86 Mon Sep 17 00:00:00 2001
From: Stephanie Chong <stephachong@gmail.com>
Date: Tue, 17 Sep 2024 19:00:10 +1000
Subject: [PATCH] Add py func links to API docstrings for categorical scores

---
 src/scores/categorical/contingency_impl.py | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/scores/categorical/contingency_impl.py b/src/scores/categorical/contingency_impl.py
index 63bff769..2d519958 100644
--- a/src/scores/categorical/contingency_impl.py
+++ b/src/scores/categorical/contingency_impl.py
@@ -631,7 +631,7 @@ def sensitivity(self) -> xr.DataArray:
 
     def specificity(self) -> xr.DataArray:
         """
-        Identical to true negative rate.
+        Identical to :py:func:`true_negative_rate`.
 
         The probability that an observed non-event will be correctly predicted.
 
@@ -654,7 +654,7 @@ def specificity(self) -> xr.DataArray:
 
     def true_negative_rate(self) -> xr.DataArray:
         """
-        Identical to specificity.
+        Identical to :py:func:`specificity`.
 
         The probability that an observed non-event will be correctly predicted.
 
@@ -745,7 +745,7 @@ def f1_score(self) -> xr.DataArray:
 
     def equitable_threat_score(self) -> xr.DataArray:
         """
-        Identical to the Gilbert Skill Score.
+        Identical to :py:func:`gilberts_skill_score`.
 
         Calculates the Equitable threat score.
 
@@ -786,7 +786,7 @@ def equitable_threat_score(self) -> xr.DataArray:
 
     def gilberts_skill_score(self) -> xr.DataArray:
         """
-        Identical to the equitable threat scores
+        Identical to :py:func:`equitable_threat_score`.
 
         Calculates the Gilbert skill score.
 
@@ -823,7 +823,7 @@ def gilberts_skill_score(self) -> xr.DataArray:
 
     def heidke_skill_score(self) -> xr.DataArray:
         """
-        Identical to Cohen's Kappa
+        Identical to :py:func:`cohens_kappa`.
 
         Calculates the Heidke skill score.
 
@@ -872,7 +872,7 @@ def heidke_skill_score(self) -> xr.DataArray:
 
     def cohens_kappa(self) -> xr.DataArray:
         """
-        Identical to the Heidke skill score.
+        Identical to :py:func:`heidke_skill_score`.
 
         Calculates Cohen's kappa.
 
@@ -964,7 +964,7 @@ def odds_ratio(self) -> xr.DataArray:
 
     def odds_ratio_skill_score(self) -> xr.DataArray:
         """
-        Identical to Yule's Q.
+        Identical to :py:func:`yules_q`.
 
         Calculates the odds ratio skill score.
 
@@ -1005,7 +1005,7 @@ def odds_ratio_skill_score(self) -> xr.DataArray:
 
     def yules_q(self) -> xr.DataArray:
         """
-        Identical to the odds ratio skill score.
+        Identical to :py:func:`odds_ratio_skill_score`.
 
         Calculates the Yule's Q.