Fix typos in code documentation

Signed-off-by: Daniel Zullo <[email protected]>

Author: daniel-zullo-frequenz

src/frequenz/sdk/_internal/_asyncio.py

@@ -15,7 +15,7 @@ async def cancel_and_await(task: asyncio.Task[Any]) -> None:
 
     Exits immediately if the task is already done.
 
-    The `CancelledError` is suppresed, but any other exception will be propagated.
+    The `CancelledError` is suppressed, but any other exception will be propagated.
 
     Args:
         task: The task to be cancelled and waited for.

src/frequenz/sdk/actor/_resampling.py

@@ -43,7 +43,7 @@ def __init__(  # pylint: disable=too-many-arguments
                 the [`DataSourcingActor`][frequenz.sdk.actor.DataSourcingActor]
                 to subscribe to component metrics.
             resampling_request_receiver: The receiver to use to receive new
-                resampmling subscription requests.
+                resampling subscription requests.
             config: The configuration for the resampler.
             name: The name of the actor. If `None`, `str(id(self))` will be used. This
                 is used mostly for debugging purposes.

src/frequenz/sdk/microgrid/_graph.py

@@ -721,7 +721,7 @@ def dfs(
         """
         Search for components that fulfill the condition in the Graph.
 
-        DFS is used for searching the graph. The graph travarsal is stopped
+        DFS is used for searching the graph. The graph traversal is stopped
         once a component fulfills the condition.
 
         Args:
@@ -730,7 +730,7 @@ def dfs(
             condition: The condition function to check for.
 
         Returns:
-            A set of component ids where the coresponding components fulfill
+            A set of component ids where the corresponding components fulfill
             the condition function.
         """
         if current_node in visited:

src/frequenz/sdk/microgrid/component/_component_data.py

@@ -180,7 +180,7 @@ class BatteryData(ComponentData):
     # pylint: enable=line-too-long
 
     temperature: float
-    """The (average) temperature reported by the battery, in Celcius (°C)."""
+    """The (average) temperature reported by the battery, in Celsius (°C)."""
 
     _relay_state: battery_pb.RelayState.ValueType
     """State of the battery relay."""

src/frequenz/sdk/timeseries/__init__.py

@@ -15,7 +15,7 @@
 Classes normally take a (re)sampling period as and argument and, optionally, an
 `align_to` argument.
 
-This means timestamps are always separated exaclty by a period, and that this
+This means timestamps are always separated exactly by a period, and that this
 timestamp falls always at multiples of the period, starting at the `align_to`.
 
 This ensures that the data is predictable and consistent among restarts.

src/frequenz/sdk/timeseries/_formula_engine/_exceptions.py

@@ -5,4 +5,4 @@
 
 
 class FormulaEngineError(Exception):
-    """An error occured while fetching metrics or applying the formula on them."""
+    """An error occurred while fetching metrics or applying the formula on them."""

src/frequenz/sdk/timeseries/_formula_engine/_formula_generators/_grid_power_formula.py

@@ -29,7 +29,7 @@ def generate(  # noqa: DOC502
         )
         grid_successors = self._get_grid_component_successors()
 
-        # generate a formula that just adds values from all commponents that are
+        # generate a formula that just adds values from all components that are
         # directly connected to the grid.  If the requested formula type is
         # `PASSIVE_SIGN_CONVENTION`, there is nothing more to do.  If the requested
         # formula type is `PRODUCTION`, the formula output is negated, then clipped to

src/frequenz/sdk/timeseries/_periodic_feature_extractor.py

@@ -35,10 +35,10 @@ class RelativePositions:
     Holds the relative positions of a window in a buffer.
 
     When calculating a profile the user has to pass two datetime objects which
-    are determaning a window. It's allowed that this window is not contained in
+    are determining a window. It's allowed that this window is not contained in
     the historical data buffer.
     In order to calculate the profile the window is shifted to the first
-    position in the buffer where it occurrs first and represented by indexes
+    position in the buffer where it occurs first and represented by indexes
     relative to the oldest sample in the buffer.
     """
 
@@ -260,7 +260,7 @@ def _get_relative_positions(
         # the current position is inside that window or the window that would
         # be overwritten next.
         #
-        # Move the window to its first appereance in the MovingWindow relative
+        # Move the window to its first appearance in the MovingWindow relative
         # to the oldest sample stored in the MovingWindow.
         #
         # In other words the oldest stored sample is considered to have index 0.
@@ -367,7 +367,7 @@ def _get_reshaped_np_array(
         """
         Create a reshaped numpy array from the MovingWindow.
 
-        The reshaped array is a two dimemsional array, where one dimension is
+        The reshaped array is a two dimensional array, where one dimension is
         the window_size and the other the number of windows returned by the
         `_get_buffer_bounds` method.
 

src/frequenz/sdk/timeseries/_quantities.py

@@ -168,7 +168,7 @@ def __format__(self, __format_spec: str) -> str:
         If specified, must be of this form: `[0].{precision}`.  If a 0 is not given, the
         trailing zeros will be omitted.  If no precision is given, the default is 3.
 
-        The returned string will use the unit that will result in the maxium precision,
+        The returned string will use the unit that will result in the maximum precision,
         based on the magnitude of the value.
 
         Example:

src/frequenz/sdk/timeseries/_ringbuffer/__init__.py

@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Ringbuffer implementation & utilties."""
+"""Ringbuffer implementation & utilities."""
 
 from .buffer import Gap, OrderedRingBuffer
 from .serialization import dump, load