Add ignore rules and document indirectly raised exceptions

The documentation linting expects functions to have a `raise` statement
for each documented exception, so we need to add ignore rules when we
want to document exceptions that are raised indirectly by other
functions called in the implementation.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

src/frequenz/sdk/actor/power_distributing/_battery_pool_status.py

@@ -70,7 +70,7 @@ class BatteryPoolStatus:
     Send set of working and uncertain batteries, when the any battery change status.
     """
 
-    def __init__(
+    def __init__(  # noqa: DOC502 (RuntimeError is raised indirectly by BatteryStatus)
         self,
         battery_ids: Set[int],
         battery_status_sender: Sender[BatteryStatus],

src/frequenz/sdk/microgrid/client/_client.py

@@ -443,7 +443,7 @@ async def _expect_category(
                 f", not a {expected_category}."
             )
 
-    async def meter_data(
+    async def meter_data(  # noqa: DOC502 (ValueError is raised indirectly by _expect_category)
         self,
         component_id: int,
         maxsize: int = RECEIVER_MAX_SIZE,
@@ -473,7 +473,7 @@ async def meter_data(
             MeterData.from_proto,
         ).new_receiver(maxsize=maxsize)
 
-    async def battery_data(
+    async def battery_data(  # noqa: DOC502 (ValueError is raised indirectly by _expect_category)
         self,
         component_id: int,
         maxsize: int = RECEIVER_MAX_SIZE,
@@ -503,7 +503,7 @@ async def battery_data(
             BatteryData.from_proto,
         ).new_receiver(maxsize=maxsize)
 
-    async def inverter_data(
+    async def inverter_data(  # noqa: DOC502 (ValueError is raised indirectly by _expect_category)
         self,
         component_id: int,
         maxsize: int = RECEIVER_MAX_SIZE,
@@ -533,7 +533,7 @@ async def inverter_data(
             InverterData.from_proto,
         ).new_receiver(maxsize=maxsize)
 
-    async def ev_charger_data(
+    async def ev_charger_data(  # noqa: DOC502 (ValueError is raised indirectly by _expect_category)
         self,
         component_id: int,
         maxsize: int = RECEIVER_MAX_SIZE,

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

@@ -25,7 +25,9 @@
 class CHPPowerFormula(FormulaGenerator[Power]):
     """Formula generator for CHP Power."""
 
-    def generate(self) -> FormulaEngine[Power]:
+    def generate(  # noqa: DOC502 (FormulaGenerationError is raised indirectly by _get_chp_meters)
+        self,
+    ) -> FormulaEngine[Power]:
         """Make a formula for the cumulative CHP power of a microgrid.
 
         The calculation is performed by adding the active power measurements from

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

@@ -14,7 +14,9 @@
 class GridCurrentFormula(FormulaGenerator[Current]):
     """Create a formula engine from the component graph for calculating grid current."""
 
-    def generate(self) -> FormulaEngine3Phase[Current]:
+    def generate(  # noqa: DOC502 (ComponentNotFound is raised indirectly by _get_grid_component_successors)
+        self,
+    ) -> FormulaEngine3Phase[Current]:
         """Generate a formula for calculating grid current from the component graph.
 
         Returns:

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

@@ -12,7 +12,7 @@
 class GridPowerFormula(FormulaGenerator[Power]):
     """Creates a formula engine from the component graph for calculating grid power."""
 
-    def generate(
+    def generate(  # noqa: DOC502 (ComponentNotFound is raised indirectly by _get_grid_component_successors)
         self,
     ) -> FormulaEngine[Power]:
         """Generate a formula for calculating grid power from the component graph.

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

@@ -17,7 +17,10 @@
 class PVPowerFormula(FormulaGenerator[Power]):
     """Creates a formula engine for calculating the PV power production."""
 
-    def generate(self) -> FormulaEngine[Power]:
+    def generate(  # noqa: DOC502 (ComponentNotFound and RuntimeError are raised
+        #                          indirectly by _get_pv_power_components)
+        self,
+    ) -> FormulaEngine[Power]:
         """Make a formula for the PV power production of a microgrid.
 
         Returns:

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

@@ -45,7 +45,7 @@ def load(path: str) -> OrderedRingBuffer[FloatArray] | None:
     return instance
 
 
-def dump(
+def dump(  # noqa: DOC502 (OSError is raised indirectly by open and pickle.dump)
     ringbuffer: OrderedRingBuffer[FloatArray],
     path: str,
     file_format_version: int = FILE_FORMAT_VERSION,

src/frequenz/sdk/timeseries/battery_pool/_component_metric_fetcher.py

@@ -169,7 +169,7 @@ class LatestBatteryMetricsFetcher(LatestMetricsFetcher[BatteryData]):
     """Subscribe for the latest battery data using MicrogridApiClient."""
 
     @classmethod
-    async def async_new(
+    async def async_new(  # noqa: DOC502 (ValueError is raised indirectly super.async_new)
         cls,
         component_id: int,
         metrics: Iterable[ComponentMetricId],
@@ -220,7 +220,7 @@ class LatestInverterMetricsFetcher(LatestMetricsFetcher[InverterData]):
     """Subscribe for the latest inverter data using MicrogridApiClient."""
 
     @classmethod
-    async def async_new(
+    async def async_new(  # noqa: DOC502 (ValueError is raised indirectly by super.async_new)
         cls,
         component_id: int,
         metrics: Iterable[ComponentMetricId],