Improve documentation for generated formula stream methods

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py

@@ -71,7 +71,7 @@ async def total_current(self) -> FormulaReceiver3Phase:
         """Fetch the total current for the EV Chargers in the pool.
 
         If a formula engine to calculate EV Charger current is not already running, it
-        will be started.  Else, we'll just get a new receiver to the already existing
+        will be started.  Else, it will return a new receiver to the already existing
         data stream.
 
         Returns:
@@ -86,12 +86,13 @@ async def total_current(self) -> FormulaReceiver3Phase:
     async def total_power(self) -> FormulaReceiver:
         """Fetch the total power for the EV Chargers in the pool.
 
-        If a formula engine to calculate EV Charger power is not already
-        running, it will be started. Else, we'll just get a new receiver
-        to the already existing data stream.
+        If a formula engine to calculate EV Charger power is not already running, it
+        will be started.  Else, it will return a new receiver to the already existing
+        data stream.
 
         Returns:
             A *new* receiver that will stream EV Charger power values.
+
         """
         return await self._formula_pool.from_generator(
             "ev_charger_total_power",

src/frequenz/sdk/timeseries/logical_meter/_logical_meter.py

@@ -144,9 +144,9 @@ async def start_formula(
     async def grid_power(self) -> FormulaReceiver:
         """Fetch the grid power for the microgrid.
 
-        If a formula engine to calculate grid power is not already running, it
-        will be started.  Else, we'll just get a new receiver to the already
-        existing data stream.
+        If a formula engine to calculate grid power is not already running, it will be
+        started.  Else, it will return a new receiver to the already existing data
+        stream.
 
         Returns:
             A *new* receiver that will stream grid_power values.
@@ -157,9 +157,9 @@ async def grid_power(self) -> FormulaReceiver:
     async def grid_current(self) -> FormulaReceiver3Phase:
         """Fetch the grid power for the microgrid.
 
-        If a formula engine to calculate grid current is not already running, it
-        will be started.  Else, we'll just get a new receiver to the already
-        existing data stream.
+        If a formula engine to calculate grid current is not already running, it will be
+        started.  Else, it will return a new receiver to the already existing data
+        stream.
 
         Returns:
             A *new* receiver that will stream grid_current values.
@@ -172,9 +172,9 @@ async def grid_current(self) -> FormulaReceiver3Phase:
     async def battery_power(self) -> FormulaReceiver:
         """Fetch the cumulative battery power in the microgrid.
 
-        If a formula engine to calculate cumulative battery power is not
-        already running, it will be started.  Else, we'll just get a new
-        receiver to the already existing data stream.
+        If a formula engine to calculate cumulative battery power is not already
+        running, it will be started.  Else, it will return a new receiver to the already
+        existing data stream.
 
         Returns:
             A *new* receiver that will stream battery_power values.
@@ -187,12 +187,13 @@ async def battery_power(self) -> FormulaReceiver:
     async def pv_power(self) -> FormulaReceiver:
         """Fetch the PV power production in the microgrid.
 
-        If a formula engine to calculate PV power production is not
-        already running, it will be started.  Else, we'll just get a new
-        receiver to the already existing data stream.
+        If a formula engine to calculate PV power production is not already running, it
+        will be started.  Else, it will return a new receiver to the already existing
+        data stream.
 
         Returns:
             A *new* receiver that will stream PV power production values.
+
         """
         return await self._formula_pool.from_generator("pv_power", PVPowerFormula)