review fixes

Author: alexhroom

RATapi/classlist.py

@@ -535,7 +535,7 @@ def _determine_class_handle(input_list: Sequence[T]):
         Returns
         -------
         class_handle : type
-            The type object of the first element which is a subcalss of all of the other
+            The type object of the first element which is a subclass of all of the other
             elements, or the first element if no such element exists.
 
         """

RATapi/examples/domains/domains_standard_layers.py

@@ -9,10 +9,10 @@ def domains_standard_layers():
     Domains standard layers projects proceed in much the same way as a normal standard layers problem,
     except that there is an additional grouping step between layers and contrasts.
 
-    Layers are grouped into ‘Domain Contrasts’.
-    The model for the actual experimental contrast is built from these domain contrasts rather than from layers.
-    There are exactly two domains for each contrast,
-    with the the ratio of them controlled by a fittable ‘domain ratio’ parameter.
+    Layers are grouped into ‘Domain Contrasts’. The model for the actual experimental contrast 
+    is built from these domain contrasts rather than from layers. There are exactly 
+    two domains for each contrast, with the the ratio of them controlled by 
+    a fittable ‘domain ratio’ parameter.
     """
     problem = RAT.Project(calculation="domains")
 

RATapi/inputs.py

@@ -161,9 +161,6 @@ def make_problem(project: RATapi.Project) -> ProblemDefinition:
     ----------
     project : RAT.Project
         The project model, which defines the physical system under study.
-    checks : RAT.rat_core.Checks
-        States whether or not to fit each parameter defined in the project.
-
 
     Returns
     -------
@@ -439,7 +436,7 @@ def make_data_present(project: RATapi.Project) -> list[int]:
 
 
 def check_indices(problem: ProblemDefinition) -> None:
-    """Check the indices a problem's contrast lists lie within the range of the corresponding parameter lists.
+    """Check the indices given in a problem's contrasts lie within the range of the corresponding parameter lists.
 
     Parameters
     ----------

RATapi/project.py

@@ -360,9 +360,9 @@ def check_contrasts(cls, value: ClassList, info: ValidationInfo):
     def model_post_init(self, __context: Any) -> None:
         """Set up the Class to protect against disallowed modification.
 
-        We initialise the class handle in the ClassLists for empty data fields, sets protected parameters, get names of
-        all defined parameters, determines the contents of the "model" field in contrasts,
-        and wraps ClassList routines to control revalidation.
+        We initialise the class handle in the ClassLists for empty data fields, set protected parameters, get names of
+        all defined parameters, determine the contents of the "model" field in contrasts,
+        and wrap ClassList routines to control revalidation.
         """
         # Ensure all ClassLists have the correct _class_handle defined
         for field in (fields := self.model_fields):

RATapi/utils/enums.py

@@ -101,8 +101,11 @@ def _missing_(cls, value: Union[int, str]):
         return super()._missing_(value)
 
     def __int__(self):
-        """Convert the DE strategy to its hardcoded index in the internal code."""
-        # as RAT core expects strategy as an integer
+        """Convert the DE strategy to its hardcoded index in the internal code.
+
+        RAT core expects strategy to be an integer, as this is how it is given to
+        the internal DE algorithm.
+        """
         return list(Strategies).index(self) + 1
 
 
@@ -130,7 +133,7 @@ class TypeOptions(RATEnum):
     """A uniform constant signal given by a parameter."""
 
     Data = "data"
-    """A signal given in the dataset for the contrast."""
+    """A signal for each q-value given by a dataset."""
 
     Function = "function"
     """A signal defined by a custom function."""