Merge pull request zedr#1 from zacharyaanglin/master

zedr · web-flow · commit 49417204dc2b · 2019-03-10T21:39:05.000+01:00
Added dataclass example to MenuConfig
diff --git a/README.md b/README.md
@@ -303,6 +303,41 @@ class MenuConfig(NamedTuple):
 
 def create_menu(config: MenuConfig):
     title, body, button_text, cancellable = config
+    # ...
+
+
+create_menu(
+    MenuConfig(
+        title="My delicious menu",
+        body="A description of the various items on the menu",
+        button_text="Order now!"
+    )
+)
+```
+
+**Even fancier**
+```python
+from dataclasses import astuple, dataclass
+
+
+@dataclass
+class MenuConfig:
+    """A configuration for the Menu.
+
+    Attributes:
+        title: The title of the Menu.
+        body: The body of the Menu.
+        button_text: The text for the button label.
+        cancellable: Can it be cancelled?
+    """
+    title: str
+    body: str
+    button_text: str
+    cancellable: bool = False
+
+def create_menu(config: MenuConfig):
+    title, body, button_text, cancellable = astuple(config)
+    # ...
 
 
 create_menu(
