style: Add missing period in docstrings (#359)

Author: ValerianRey

src/torchjd/aggregation/_utils/str.py

@@ -4,7 +4,7 @@
 def vector_to_str(vector: Tensor) -> str:
     """
     Transforms a Tensor of the form `tensor([1.23456, 1.0, ...])` into a string of the form
-    `1.23, 1., ...`
+    `1.23, 1., ...`.
     """
 
     weights_str = ", ".join(["{:.2f}".format(value).rstrip("0") for value in vector])

tests/plots/_utils.py

@@ -236,7 +236,7 @@ def combine_bounds(
 def coord_to_angle(x: float, y: float) -> tuple[float, float]:
     """
     Converts an (x, y) pair into its angle from the (1, 0) vector, as a value in [0, 2pi[, and its
-    length
+    length.
     """
 
     r = np.sqrt(x**2 + y**2)

tests/unit/aggregation/test_cagrad.py

@@ -29,7 +29,7 @@ def test_non_differentiable(aggregator: CAGrad, matrix: Tensor):
 
 @mark.parametrize(["aggregator", "matrix"], non_conflicting_pairs_1 + non_conflicting_pairs_2)
 def test_non_conflicting(aggregator: CAGrad, matrix: Tensor):
-    """Tests that CAGrad is non-conflicting when c >= 1 (it should not hold when c < 1)"""
+    """Tests that CAGrad is non-conflicting when c >= 1 (it should not hold when c < 1)."""
     assert_non_conflicting(aggregator, matrix)
 
 

tests/unit/autojac/test_backward.py

@@ -10,7 +10,7 @@
 
 
 def test_check_create_transform():
-    """Tests that _create_transform creates a valid Transform"""
+    """Tests that _create_transform creates a valid Transform."""
 
     a1 = torch.tensor([1.0, 2.0], requires_grad=True)
     a2 = torch.tensor([3.0, 4.0], requires_grad=True)

tests/unit/autojac/test_mtl_backward.py

@@ -10,7 +10,7 @@
 
 
 def test_check_create_transform():
-    """Tests that _create_transform creates a valid Transform"""
+    """Tests that _create_transform creates a valid Transform."""
 
     p0 = torch.tensor([1.0, 2.0], requires_grad=True)
     p1 = torch.tensor([1.0, 2.0], requires_grad=True)