Improve __repr__ documentation

llucax · llucax · commit 0ba720f4b0c4 · 2024-03-05T11:26:32.000+01:00
Signed-off-by: Leandro Lucarella &lt;luca-frequenz@llucax.com&gt;
diff --git a/src/frequenz/channels/_select.py b/src/frequenz/channels/_select.py
@@ -248,7 +248,7 @@ def __str__(self) -> str:
         )
 
     def __repr__(self) -> str:
-        """Return a the internal representation of this selected receiver."""
+        """Return a string with the internal representation of this instance."""
         return (
             f"{type(self).__name__}({self._recv=}, {self._value=}, "
             f"{self._exception=}, {self._handled=})"

Original file line number	Diff line number	Diff line change
`@@ -248,7 +248,7 @@ def __str__(self) -> str:`
`248`	`248`	`)`
`249`	`249`
`250`	`250`	`def __repr__(self) -> str:`
`251`		`- """Return a the internal representation of this selected receiver."""`
	`251`	`+ """Return a string with the internal representation of this instance."""`
`252`	`252`	`return (`
`253`	`253`	`f"{type(self).__name__}({self._recv=}, {self._value=}, "`
`254`	`254`	`f"{self._exception=}, {self._handled=})"`