Rename Merge to Merger

In this case it is better to introduce a breaking change to make sure
users update to using the new `merge()` function. Also using a noun for
the name is more in line with the other classes.

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

Author: llucax

src/frequenz/channels/__init__.py

@@ -77,7 +77,7 @@
 from ._anycast import Anycast
 from ._broadcast import Broadcast
 from ._exceptions import ChannelClosedError, ChannelError, Error
-from ._merge import Merge, merge
+from ._merge import Merger, merge
 from ._receiver import Receiver, ReceiverError, ReceiverStoppedError
 from ._select import (
     Selected,
@@ -95,7 +95,7 @@
     "ChannelClosedError",
     "ChannelError",
     "Error",
-    "Merge",
+    "Merger",
     "Receiver",
     "ReceiverError",
     "ReceiverStoppedError",

src/frequenz/channels/_merge.py

@@ -15,7 +15,7 @@
 _T = TypeVar("_T")
 
 
-def merge(*receivers: Receiver[_T]) -> Merge[_T]:
+def merge(*receivers: Receiver[_T]) -> Merger[_T]:
     """Merge messages coming from multiple receivers into a single stream.
 
     Example:
@@ -48,19 +48,19 @@ def merge(*receivers: Receiver[_T]) -> Merge[_T]:
     if not receivers:
         raise ValueError("At least one receiver must be provided")
 
-    return Merge(*receivers, name="merge")
+    return Merger(*receivers, name="merge")
 
 
-class Merge(Receiver[_T]):
+class Merger(Receiver[_T]):
     """A receiver that merges messages coming from multiple receivers into a single stream.
 
     Tip:
         Please consider using the more idiomatic [`merge()`][freq.channels.merge]
-        function instead of creating a `Merge` instance directly.
+        function instead of creating a `Merger` instance directly.
     """
 
     def __init__(self, *receivers: Receiver[_T], name: str | None) -> None:
-        """Create a `Merge` instance.
+        """Create a `Merger` instance.
 
         Args:
             *receivers: The receivers to merge.
@@ -84,7 +84,7 @@ def __del__(self) -> None:
                 task.cancel()
 
     async def stop(self) -> None:
-        """Stop the `Merge` instance and cleanup any pending tasks."""
+        """Stop the `Merger` instance and cleanup any pending tasks."""
         for task in self._pending:
             task.cancel()
         await asyncio.gather(*self._pending, return_exceptions=True)