chore: document eventemitter methods in the API

pavelfeldman · pavelfeldman · commit f62d181a0888 · 2020-11-30T10:00:55.000-08:00
diff --git a/playwright/async_base.py b/playwright/async_base.py
@@ -64,11 +64,16 @@ def _wrap_handler(self, handler: Any) -> Callable[..., None]:
             return mapping.wrap_handler(handler)
         return handler
 
-    def on(self, event_name: str, handler: Any) -> None:
-        self._impl_obj.on(event_name, self._wrap_handler(handler))
-
-    def once(self, event_name: str, handler: Any) -> None:
-        self._impl_obj.once(event_name, self._wrap_handler(handler))
-
-    def remove_listener(self, event_name: str, handler: Any) -> None:
-        self._impl_obj.remove_listener(event_name, self._wrap_handler(handler))
+    def on(self, event: str, f: Any) -> None:
+        """Registers the function ``f`` to the event name ``event``."""
+        self._impl_obj.on(event, self._wrap_handler(f))
+
+    def once(self, event: str, f: Any) -> None:
+        """The same as ``self.on``, except that the listener is automatically
+        removed after being called.
+        """
+        self._impl_obj.once(event, self._wrap_handler(f))
+
+    def remove_listener(self, event: str, f: Any) -> None:
+        """Removes the function ``f`` from ``event``."""
+        self._impl_obj.remove_listener(event, self._wrap_handler(f))
diff --git a/playwright/sync_base.py b/playwright/sync_base.py
@@ -111,14 +111,19 @@ def _wrap_handler(self, handler: Any) -> Callable[..., None]:
             return mapping.wrap_handler(handler)
         return handler
 
-    def on(self, event_name: str, handler: Any) -> None:
-        self._impl_obj.on(event_name, self._wrap_handler(handler))
-
-    def once(self, event_name: str, handler: Any) -> None:
-        self._impl_obj.once(event_name, self._wrap_handler(handler))
-
-    def remove_listener(self, event_name: str, handler: Any) -> None:
-        self._impl_obj.remove_listener(event_name, self._wrap_handler(handler))
+    def on(self, event: str, f: Any) -> None:
+        """Registers the function ``f`` to the event name ``event``."""
+        self._impl_obj.on(event, self._wrap_handler(f))
+
+    def once(self, event: str, f: Any) -> None:
+        """The same as ``self.on``, except that the listener is automatically
+        removed after being called.
+        """
+        self._impl_obj.once(event, self._wrap_handler(f))
+
+    def remove_listener(self, event: str, f: Any) -> None:
+        """Removes the function ``f`` from ``event``."""
+        self._impl_obj.remove_listener(event, self._wrap_handler(f))
 
     def _gather(self, *actions: Callable) -> List[Any]:
         g_self = greenlet.getcurrent()
