update dostrings

Author: andreascaglioni

src/python_project_template_AS/calculator.py

@@ -17,27 +17,21 @@
 
 
 class Calculator:
-    """Thin calculator wrapper around an OperationRegistry.
-
-    Methods:
-        register(op, replace=False): Register an Operation.
-        apply(op_name, *args): Apply a registered operation.
-        compose(ops, left_to_right=True): Compose unary operations.
-        chain(sequence, initial): Apply a mixed sequence DSL-style.
-    """
+    """Calculator using an OperationRegistry."""
 
     def __init__(self, registry: Optional[OperationRegistry] = None):
+        """Create a Calculator with an optional registry."""
         if registry is None:
             self.registry = OperationRegistry()
         else:
             self.registry = registry
 
     def register(self, op: Operation, *, replace: bool = False) -> None:
-
+        """Register an operation, optionally replacing existing."""
         self.registry.register(op, replace=replace)
 
     def apply(self, op_name: str, *args: Any) -> Any:
-
+        """Apply a named operation with arguments."""
         op = self.registry.get(op_name)
         try:
             return op(*args)
@@ -49,7 +43,7 @@ def apply(self, op_name: str, *args: Any) -> Any:
     def compose(
         self, ops: Iterable[str], *, left_to_right: bool = True
     ) -> Callable[[Any], Any]:
-
+        """Compose unary operations into a single callable."""
         op_list: List[Operation] = [self.registry.get(name) for name in ops]
         for op in op_list:
             if op.arity != 1:
@@ -74,7 +68,7 @@ def composed(x):
         return composed
 
     def chain(self, sequence: Iterable[Union[str, int]], initial: Any) -> Any:
-
+        """Apply a sequence of operations and values starting from initial."""
         seq = list(sequence)
         cur = initial
         i = 0

src/python_project_template_AS/exceptions.py

@@ -7,16 +7,12 @@
 
 
 class CalculatorError(Exception):
-    """Base class for calculator-related errors.
-
-    Use this as the top-level exception when handling errors coming from the
-    package.
-    """
+    """Base exception for calculator errors."""
 
 
 class OperationError(CalculatorError):
-    """Raised when an operation fails (wrong arity, invalid input, etc.)."""
+    """Raised for operation failures (e.g., wrong arity, invalid input)."""
 
 
 class RegistryError(CalculatorError):
-    """Raised for registry problems (duplicate name, not found)."""
+    """Raised for registry errors (duplicate or missing name)."""

src/python_project_template_AS/operations.py

@@ -13,19 +13,27 @@
 
 @dataclass
 class Operation:
-    """Container for a named callable with an expected arity.
+    """Named callable with arity check.
 
     Attributes:
-        name: operation name used for registry lookups.
-        func: callable implementing the operation.
-        arity: number of positional arguments expected by the operation.
+        name (str): Operation name.
+        func (Callable): Operation function.
+        arity (int): Expected argument count.
     """
 
     name: str
     func: Callable[..., Any]
     arity: int = 1
 
     def __call__(self, *args):
+        """Call operation, checking argument count.
+
+        Args:
+            *args: Arguments for the operation.
+
+        Raises:
+            OperationError: If argument count is wrong.
+        """
         if len(args) != self.arity:
             raise OperationError(
                 f"Operation '{self.name}' expects {self.arity} arguments, got {len(args)}"

src/python_project_template_AS/utils.py

@@ -8,9 +8,5 @@
 
 
 def is_number(x: Any) -> bool:
-    """Return True if ``x`` is an int or float.
-
-    Useful in examples and tests to guard numeric operations.
-    """
-
+    """Return True if x is int or float."""
     return isinstance(x, (int, float))