Apply wording suggestions

Co-authored-by: Hajar AIT EL KADI <[email protected]>

openfisca_core/commons/rates.py

@@ -22,7 +22,7 @@ def average_rate(
     """Computes the average rate of a target net income.
 
     Given a `target` net income, and according to the `varying` gross income.
-    Optionally, a `trim` can be applied consisting on the lower and upper
+    Optionally, a `trim` can be applied consisting of the lower and the upper
     bounds of the average rate to be computed.
 
     Args:
@@ -69,7 +69,7 @@ def marginal_rate(
     """Computes the marginal rate of a target net income.
 
     Given a `target` net income, and according to the `varying` gross income.
-    Optionally, a `trim` can be applied consisting on the lower and upper
+    Optionally, a `trim` can be applied consisting of the lower and the upper
     bounds of the marginal rate to be computed.
 
     Args:

openfisca_core/commons/tests/test_dummy.py

@@ -6,7 +6,7 @@
 
 
 def test_dummy_deprecation():
-    """When instantiated Dummy throws a deprecation warning."""
+    """Dummy throws a deprecation warning when instantiated."""
 
     with pytest.warns(DeprecationWarning):
         result = Dummy()

openfisca_core/commons/tests/test_formulas.py

@@ -20,7 +20,7 @@ def test_apply_thresholds_when_several_inputs():
 
 
 def test_apply_thresholds_when_too_many_thresholds():
-    """When thresholds > choices it raises an AssertionError."""
+    """Raises an AssertionError when thresholds > choices."""
 
     input_ = numpy.array([6])
     thresholds = [5, 7, 9, 11]
@@ -32,7 +32,7 @@ def test_apply_thresholds_when_too_many_thresholds():
 
 
 def test_apply_thresholds_when_too_many_choices():
-    """When thresholds < choices - 1 it raises an AssertionError."""
+    """Raises an AssertionError when thresholds < choices - 1."""
 
     input_ = numpy.array([6])
     thresholds = [5, 7]
@@ -44,7 +44,7 @@ def test_apply_thresholds_when_too_many_choices():
 
 
 def test_switch_when_values_are_empty():
-    """When the values are empty it raises an AssertionError."""
+    """Raises an AssertionError when the values are empty it."""
 
     conditions = [1, 1, 1, 2]
     value_by_condition = {}

openfisca_core/entities/helpers.py

@@ -77,6 +77,7 @@ def build_entity(
         <openfisca_core.entities.entity.Entity...
 
     """
+
     if is_person:
         return entities.Entity(key, plural, label, doc)
     else:

openfisca_core/entities/role.py

@@ -58,6 +58,7 @@ class Role:
         ...     }
         >>> Role(description, object())
         Role(parent)
+
     """
 
     entity: Entity

openfisca_core/entities/tests/test_entity.py

@@ -6,7 +6,7 @@
 
 
 def test_check_role_validity_when_not_role():
-    """When it gets an invalid role it raises a ValueError."""
+    """Raises a ValueError when it gets an invalid role."""
 
     with pytest.raises(ValueError):
         entity = Entity("key", "label", "plural", "doc")

openfisca_core/entities/tests/test_helpers.py

@@ -8,7 +8,7 @@
 
 
 def test_build_group_entity_without_roles():
-    """When its called without roles it raises a TypeError."""
+    """Raises a TypeError when it's called without roles."""
 
     build_entity = functools.partial(helpers.build_entity, "", "", "")