Backquote keywords in documentation

Also fix a documentation grammar mistake involving the removal of a
comma.

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

Author: shsms

RELEASE_NOTES.md

@@ -8,13 +8,13 @@
 
 - `microgrid.battery_pool()` method now accepts a priority value.
 
-- BatteryPool's control methods
+- `BatteryPool`'s control methods
 
   * Original methods `{set_power/charge/discharge}` are now replaced by `propose_{power/charge/discharge}`
   * The `propose_*` methods send power proposals to the `PowerManagingActor`, where it can be overridden by proposals from other actors.
   * They no longer have the `adjust_power` flag, because the `PowerManagingActor` will always adjust power to fit within the available bounds.
 
-- BatteryPool's reporting methods
+- `BatteryPool`'s reporting methods
 
   * `power_bounds` is replaced by `power_status`
   * The `power_status` method streams objects containing:
@@ -49,7 +49,7 @@
   batteries.
   This means that one or more inverters can be connected to one or more batteries.
 
-- A PowerManagingActor implementation
+- A `PowerManagingActor` implementation
 
 ## Bug Fixes
 

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -192,21 +192,20 @@ def battery_pool(
         name: str | None = None,
         priority: int = -sys.maxsize - 1,
     ) -> BatteryPool:
-        """Return a new BatteryPool instance for the given ids.
+        """Return a new `BatteryPool` instance for the given ids.
 
-        If a BatteryPoolReferenceStore instance for the given battery ids doesn't exist,
-        a new one is created and used for creating the BatteryPool.
+        If a `BatteryPoolReferenceStore` instance for the given battery ids doesn't exist,
+        a new one is created and used for creating the `BatteryPool`.
 
         Args:
             battery_ids: Optional set of IDs of batteries to be managed by the
-                BatteryPool.
+                `BatteryPool`.
             name: An optional name used to identify this instance of the pool or a
                 corresponding actor in the logs.
             priority: The priority of the actor making the call.
 
         Returns:
-            A BatteryPool instance.
-
+            A `BatteryPool` instance.
         """
         from ..timeseries.battery_pool import BatteryPool
         from ..timeseries.battery_pool._battery_pool_reference_store import (
@@ -433,7 +432,7 @@ def battery_pool(
     name: str | None = None,
     priority: int = -sys.maxsize - 1,
 ) -> BatteryPool:
-    """Return a new BatteryPool instance for the given parameters.
+    """Return a new `BatteryPool` instance for the given parameters.
 
     The priority value is used to resolve conflicts when multiple actors are trying to
     propose different power values for the same set of batteries.
@@ -443,14 +442,14 @@ def battery_pool(
         priority is the lowest possible value.
 
     Args:
-        battery_ids: Optional set of IDs of batteries to be managed by the BatteryPool.
+        battery_ids: Optional set of IDs of batteries to be managed by the `BatteryPool`.
             If not specified, all batteries available in the component graph are used.
         name: An optional name used to identify this instance of the pool or a
             corresponding actor in the logs.
         priority: The priority of the actor making the call.
 
     Returns:
-        A BatteryPool instance.
+        A `BatteryPool` instance.
     """
     return _get().battery_pool(battery_ids, name, priority)
 

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

@@ -28,7 +28,7 @@ class BatteryPoolReferenceStore:  # pylint: disable=too-many-instance-attributes
     - the formula engine pool and metric calculators.
     - the tasks for updating the battery status for the metric calculators.
 
-    These are independent of the priority of the actors, and can be shared between
+    These are independent of the priority of the actors and can be shared between
     multiple users of the same set of batteries.
 
     They are exposed through the BatteryPool class.