Start comment with a cap letter

Author: bobleesj

tests/test_diffraction_objects.py

@@ -186,7 +186,7 @@ def test_init_invalid_xtype():
     "org_do_args, target_do_args, scale_inputs, expected",
     [
         # Test that scale_to() scales to the correct values
-        # C1: same x-array and y-array, check offset
+        # C1: Same x-array and y-array, check offset
         (
             {
                 "xarray": np.array([10, 15, 25, 30, 60, 140]),
@@ -208,7 +208,7 @@ def test_init_invalid_xtype():
             },
             {"xtype": "tth", "yarray": np.array([4.1, 5.1, 6.1, 7.1, 8.1, 9.1])},
         ),
-        # C2: same length x-arrays with exact x-value match
+        # C2: Same length x-arrays with exact x-value match
         (
             {
                 "xarray": np.array([10, 15, 25, 30, 60, 140]),
@@ -230,7 +230,7 @@ def test_init_invalid_xtype():
             },
             {"xtype": "tth", "yarray": np.array([1, 2, 2.5, 3, 6, 10])},
         ),
-        # C3: same length x-arrays with approximate x-value match
+        # C3: Same length x-arrays with approximate x-value match
         (
             {
                 "xarray": np.array([0.12, 0.24, 0.31, 0.4]),
@@ -252,7 +252,7 @@ def test_init_invalid_xtype():
             },
             {"xtype": "q", "yarray": np.array([1, 2, 4, 6])},
         ),
-        # C4: different x-array lengths with approximate x-value match
+        # C4: Different x-array lengths with approximate x-value match
         (
             {
                 "xarray": np.array([10, 25, 30.1, 40.2, 61, 120, 140]),
@@ -290,7 +290,7 @@ def test_scale_to(org_do_args, target_do_args, scale_inputs, expected):
 @pytest.mark.parametrize(
     "org_do_args, target_do_args, scale_inputs",
     [
-        # UC1: user did not specify anything
+        # UC1: User did not specify anything
         (
             {
                 "xarray": np.array([0.1, 0.2, 0.3]),
@@ -311,7 +311,7 @@ def test_scale_to(org_do_args, target_do_args, scale_inputs, expected):
                 "offset": 0,
             },
         ),
-        # UC2: user specified more than one of q, tth, and d
+        # UC2: User specified more than one of q, tth, and d
         (
             {
                 "xarray": np.array([10, 25, 30.1, 40.2, 61, 120, 140]),
@@ -352,12 +352,12 @@ def test_scale_to_bad(org_do_args, target_do_args, scale_inputs):
 @pytest.mark.parametrize(
     "wavelength, xarray, yarray, xtype_1, xtype_2, value, expected_index",
     [
-        # UC1: exact match
+        # UC1: Exact match
         (4 * np.pi, np.array([30.005, 60]), np.array([1, 2]), "tth", "tth", 30.005, [0]),
-        # UC2: target value lies in the array, returns the (first) closest index
+        # UC2: Target value lies in the array, returns the (first) closest index
         (4 * np.pi, np.array([30, 60]), np.array([1, 2]), "tth", "tth", 45, [0]),
         (4 * np.pi, np.array([30, 60]), np.array([1, 2]), "tth", "q", 0.25, [0]),
-        # UC3: target value out of the range, returns the closest index
+        # UC3: Target value out of the range, returns the closest index
         (4 * np.pi, np.array([0.25, 0.5, 0.71]), np.array([1, 2, 3]), "q", "q", 0.1, [0]),
         (4 * np.pi, np.array([30, 60]), np.array([1, 2]), "tth", "tth", 63, [1]),
     ],
@@ -411,7 +411,7 @@ def test_dump(tmp_path, mocker):
 @pytest.mark.parametrize(
     "do_init_args, expected_do_dict, divide_by_zero_warning_expected",
     [
-        (  # instantiate just array attributes
+        (  # Instantiate just array attributes
             {
                 "xarray": np.array([0.0, 90.0, 180.0]),
                 "yarray": np.array([1.0, 2.0, 3.0]),
@@ -440,7 +440,7 @@ def test_dump(tmp_path, mocker):
             },
             True,
         ),
-        (  # instantiate just array attributes
+        (  # Instantiate just array attributes
             {
                 "xarray": np.array([np.inf, 2 * np.sqrt(2) * np.pi, 2 * np.pi]),
                 "yarray": np.array([1.0, 2.0, 3.0]),
@@ -487,11 +487,11 @@ def test_init_valid(do_init_args, expected_do_dict, divide_by_zero_warning_expec
 @pytest.mark.parametrize(
     "do_init_args, expected_error_msg",
     [
-        (  # C1: no arguments provided
+        (  # C1: No arguments provided
             {},
             "missing 3 required positional arguments: 'xarray', 'yarray', and 'xtype'",
         ),
-        (  # C2: only xarray and yarray provided
+        (  # C2: Only xarray and yarray provided
             {"xarray": np.array([0.0, 90.0]), "yarray": np.array([0.0, 90.0])},
             "missing 1 required positional argument: 'xtype'",
         ),

tests/test_transforms.py

@@ -96,14 +96,14 @@ def test_tth_to_q(wavelength, tth, expected_q, wavelength_warning_msg):
 @pytest.mark.parametrize(
     "wavelength, tth, expected_error_type, expected_error_msg",
     [
-        # C1: invalid tth value of > 180 degrees, no wavelength, expect two theta ValueError
+        # C1: Invalid tth value of > 180 degrees, no wavelength, expect two theta ValueError
         (
             None,
             np.array([0, 30, 60, 90, 120, 181]),
             ValueError,
             "Two theta exceeds 180 degrees. Please check the input values for errors.",
         ),
-        # C2: invalid tth value of > 180 degrees with wavelength, expect two theta ValueError
+        # C2: Invalid tth value of > 180 degrees with wavelength, expect two theta ValueError
         (
             4 * np.pi,
             np.array([0, 30, 60, 90, 120, 181]),
@@ -121,16 +121,16 @@ def test_tth_to_q_bad(wavelength, tth, expected_error_type, expected_error_msg):
     "q, expected_d, warning_expected",
     [
         # Test conversion of q to d with valid values
-        # C1: empty q values, expect empty d values
+        # C1: Empty q values, expect empty d values
         (np.array([]), np.array([]), False),
         # C2:
-        # 1. valid q values, expect d values without warning
+        # 1. Valid q values, expect d values without warning
         (
             np.array([0.1, 1 * np.pi, 2 * np.pi, 3 * np.pi, 4 * np.pi, 5 * np.pi]),
             np.array([62.83185307, 2, 1, 0.66667, 0.5, 0.4]),
             False,
         ),
-        # 2. valid q values containing 0, expect d values with divide by zero warning
+        # 2. Valid q values containing 0, expect d values with divide by zero warning
         (
             np.array([0, 1 * np.pi, 2 * np.pi, 3 * np.pi, 4 * np.pi, 5 * np.pi]),
             np.array([np.inf, 2, 1, 0.66667, 0.5, 0.4]),
@@ -173,9 +173,9 @@ def test_d_to_q(d, expected_q, zero_divide_error_expected):
     "wavelength, tth, expected_d, divide_by_zero_warning_expected",
     [
         # Test conversion of q to d with valid values
-        # C1: empty tth values, no, expect empty d values
+        # C1: Empty tth values, no, expect empty d values
         (None, np.array([]), np.array([]), False),
-        # C2: empty tth values, wavelength provided, expect empty d values
+        # C2: Empty tth values, wavelength provided, expect empty d values
         (4 * np.pi, np.array([]), np.array([]), False),
         # C3: User specified valid tth values between 0-180 degrees (without wavelength)
         (None, np.array([0, 30, 60, 90, 120, 180]), np.array([0, 1, 2, 3, 4, 5]), False),
@@ -203,14 +203,14 @@ def test_tth_to_d(wavelength, tth, expected_d, divide_by_zero_warning_expected,
 @pytest.mark.parametrize(
     "wavelength, tth, expected_error_type, expected_error_msg",
     [
-        # C1: user specified an invalid tth value of > 180 degrees (without wavelength)
+        # C1: User specified an invalid tth value of > 180 degrees (without wavelength)
         (
             None,
             np.array([0, 30, 60, 90, 120, 181]),
             ValueError,
             "Two theta exceeds 180 degrees. Please check the input values for errors.",
         ),
-        # C2: user specified an invalid tth value of > 180 degrees (with wavelength)
+        # C2: User specified an invalid tth value of > 180 degrees (with wavelength)
         (
             4 * np.pi,
             np.array([0, 30, 60, 90, 120, 181]),
@@ -259,9 +259,9 @@ def test_d_to_tth(wavelength, d, expected_tth, divide_by_zero_warning_expected,
 @pytest.mark.parametrize(
     "wavelength, d, expected_error_type",
     [
-        # C1: user specified invalid d values that result in tth > 180 degrees
+        # C1: User specified invalid d values that result in tth > 180 degrees
         (4 * np.pi, np.array([1.2, 1, 0.8, 0.6, 0.4, 0.2]), ValueError),
-        # C2: user specified a wrong wavelength that result in tth > 180 degrees
+        # C2: User specified a wrong wavelength that result in tth > 180 degrees
         (100, np.array([1.2, 1, 0.8, 0.6, 0.4, 0.2]), ValueError),
     ],
 )