Apply suggestions from code review

Lightning-AI · Sep 13, 2024 · 9baf6e6 · 9baf6e6
1 parent 48f584f
commit 9baf6e6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/src/torchmetrics/classification/dice.py b/src/torchmetrics/classification/dice.py
@@ -116,9 +116,9 @@ class Dice(Metric):
         kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.
 
     .. warning::
-        The `dice` metrics is being deprecated from the classification subpackage in v1.6.0 of torchmetrics and will be
-        removed in v1.7.0. Please instead consider using `f1score` metric from the classification subpackage as it
-        provides the same functionality. Additionally, we are going to re-add the `dice` metric in the segmentation
+        The ``dice`` metrics is being deprecated from the classification subpackage in v1.6.0 of torchmetrics and will be
+        removed in v1.7.0. Please instead consider using ``f1score`` metric from the classification subpackage as it
+        provides the same functionality. Additionally, we are going to re-add the ``dice`` metric in the segmentation
         domain in v1.6.0 with slight modifications to functionality.
 
     Raises:

diff --git a/src/torchmetrics/functional/classification/dice.py b/src/torchmetrics/functional/classification/dice.py
@@ -152,9 +152,9 @@ def dice(
             than what they appear to be.
 
     .. warning::
-        The `dice` metrics is being deprecated from the classification subpackage in v1.6.0 of torchmetrics and will be
-        removed in v1.7.0. Please instead consider using `f1score` metric from the classification subpackage as it
-        provides the same functionality. Additionally, we are going to re-add the `dice` metric in the segmentation
+        The ``dice`` metrics is being deprecated from the classification subpackage in v1.6.0 of torchmetrics and will be
+        removed in v1.7.0. Please instead consider using ``f1score`` metric from the classification subpackage as it
+        provides the same functionality. Additionally, we are going to re-add the ``dice`` metric in the segmentation
         domain in v1.6.0 with slight modifications to functionality.
 
     Return: