Update documentation

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

README.md

@@ -24,14 +24,19 @@ Here's a quick example to get you started:
 
 ```python
 from frequenz.client.dispatch import Client
+import asyncio
 
-# Initialize the client
-client = Client(key="your_api_key", server_url="grpc://fz-0004.frequenz.io")
+async def print_dispatches():
+    # Initialize the client
+    client = Client(key="your_api_key", server_url="grpc://fz-0004.frequenz.io")
 
-# List all dispatches for a specific microgrid
-async for page in client.list(microgrid_id=1):
-    for dispatch in page:
-        print(dispatch)
+    # List all dispatches for a specific microgrid
+    async for page in client.list(microgrid_id=1):
+        for dispatch in page:
+            print(dispatch)
+
+# Run the Example
+asyncio.run(print_dispatches())
 ```
 
 For detailed usage and advanced features, check out the [client documentation](https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.Client).

src/frequenz/client/dispatch/_client.py

@@ -249,9 +249,6 @@ async def create(  # pylint: disable=too-many-positional-arguments
     ) -> Dispatch:
         """Create a dispatch.
 
-        Will try to return the created dispatch, identifying it by
-        the same fields as the request.
-
         Args:
             microgrid_id: The microgrid_id to create the dispatch for.
             type: User defined string to identify the dispatch type.