Remove commented code and add documentation placeholders

Author: AndrewSazonov

src/easydiffraction/analysis/categories/aliases.py

@@ -66,8 +66,6 @@ def __init__(
             ),
         )
 
-        # self._category_entry_attr_name = self.label.name
-        # self.name = self.label.value
         self._identity.category_code = 'alias'
         self._identity.category_entry_name = lambda: self.label.value
 

src/easydiffraction/analysis/categories/constraints.py

@@ -61,8 +61,7 @@ def __init__(
                 ]
             ),
         )
-        # self._category_entry_attr_name = self.lhs_alias.name
-        # self.name = self.lhs_alias.value
+
         self._identity.category_code = 'constraint'
         self._identity.category_entry_name = lambda: self.lhs_alias.value
 

src/easydiffraction/analysis/categories/joint_fit_experiments.py

@@ -64,8 +64,6 @@ def __init__(
             ),
         )
 
-        # self._category_entry_attr_name = self.id.name
-        # self.name = self.id.value
         self._identity.category_code = 'joint_fit_experiment'
         self._identity.category_entry_name = lambda: self.id.value
 

src/easydiffraction/core/validation.py

@@ -40,6 +40,10 @@ def expected_type(self):
         return self.value
 
 
+# ==============================================================
+# Runtime type checking decorator
+# ==============================================================
+
 # Runtime type checking decorator for validating those methods
 # annotated with type hints, which are writable for the user, and
 # which are not covered by custom validators for Parameter attribute
@@ -77,6 +81,8 @@ def wrapper(*args, **kwargs):
 # ==============================================================
 # Validation stages (enum/constant)
 # ==============================================================
+
+
 class ValidationStage(Enum):
     """Phases of validation for diagnostic logging."""
 
@@ -274,6 +280,11 @@ def validated(
         return value
 
 
+# ==============================================================
+# Attribute specification holding metadata and validators
+# ==============================================================
+
+
 class AttributeSpec:
     """Hold metadata and validators for a single attribute."""
 

src/easydiffraction/experiments/categories/background/base.py

@@ -28,6 +28,7 @@ def calculate(self, x_data: Any) -> Any:
         """
         pass
 
+    # TODO: Consider moving to CategoryCollection
     @abstractmethod
     def show(self) -> None:
         """Print a human-readable view of background components."""

src/easydiffraction/experiments/categories/background/enums.py

@@ -7,6 +7,7 @@
 from enum import Enum
 
 
+# TODO: Consider making EnumBase class with: default, description, ...
 class BackgroundTypeEnum(str, Enum):
     """Supported background model types."""
 

src/easydiffraction/experiments/categories/instrument/base.py

@@ -1,3 +1,8 @@
+"""Instrument category base definitions for CWL/TOF instruments.
+
+This module provides the shared parent used by concrete instrument
+implementations under the instrument category.
+"""
 # SPDX-FileCopyrightText: 2021-2025 EasyDiffraction contributors <https://github.com/easyscience/diffraction>
 # SPDX-License-Identifier: BSD-3-Clause
 
@@ -14,5 +19,6 @@ class InstrumentBase(CategoryItem):
     """
 
     def __init__(self) -> None:
+        """Initialize instrument base and set category code."""
         super().__init__()
         self._identity.category_code = 'instrument'

src/easydiffraction/experiments/categories/instrument/tof.py

@@ -124,30 +124,30 @@ def calib_d_to_tof_offset(self, value):
 
     @property
     def calib_d_to_tof_linear(self):
-        """Linear d→TOF conversion coefficient (µs/Å)."""
+        """Linear d to TOF conversion coefficient (µs/Å)."""
         return self._calib_d_to_tof_linear
 
     @calib_d_to_tof_linear.setter
     def calib_d_to_tof_linear(self, value):
-        """Set linear d→TOF coefficient (µs/Å)."""
+        """Set linear d to TOF coefficient (µs/Å)."""
         self._calib_d_to_tof_linear.value = value
 
     @property
     def calib_d_to_tof_quad(self):
-        """Quadratic d→TOF correction coefficient (µs/Ų)."""
+        """Quadratic d to TOF correction coefficient (µs/Ų)."""
         return self._calib_d_to_tof_quad
 
     @calib_d_to_tof_quad.setter
     def calib_d_to_tof_quad(self, value):
-        """Set quadratic d→TOF correction (µs/Ų)."""
+        """Set quadratic d to TOF correction (µs/Ų)."""
         self._calib_d_to_tof_quad.value = value
 
     @property
     def calib_d_to_tof_recip(self):
-        """Reciprocal-velocity d→TOF correction (µs·Å)."""
+        """Reciprocal-velocity d to TOF correction (µs·Å)."""
         return self._calib_d_to_tof_recip
 
     @calib_d_to_tof_recip.setter
     def calib_d_to_tof_recip(self, value):
-        """Set reciprocal-velocity d→TOF correction (µs·Å)."""
+        """Set reciprocal-velocity d to TOF correction (µs·Å)."""
         self._calib_d_to_tof_recip.value = value

src/easydiffraction/experiments/categories/linked_phases.py

@@ -54,8 +54,6 @@ def __init__(
                 ]
             ),
         )
-        # self._category_entry_attr_name = self.id.name
-        # self.name = self.id.value
         self._identity.category_code = 'linked_phases'
         self._identity.category_entry_name = lambda: self.id.value
 

src/easydiffraction/experiments/categories/peak/factory.py

@@ -8,6 +8,7 @@
 from easydiffraction.experiments.experiment.enums import ScatteringTypeEnum
 
 
+# TODO: Consider inheriting from FactoryBase
 class PeakFactory:
     """Factory for creating peak profile objects.