Merge remote-tracking branch 'origin/forman-34-component_docs' into forman-34-component_docs

Author: forman

chartlets.py/chartlets/component.py

@@ -25,10 +25,10 @@ class Component(ABC):
     #
     # Special non-HTML properties
     label: str | None = None
-    """Optional label used by many specific components."""
+    """Label used by many specific components. Optional """
 
     children: list["Component"] | None = None
-    """Optional children used by many specific components."""
+    """Children used by many specific components. Optional """
 
     @property
     def type(self):

chartlets.py/chartlets/components/box.py

@@ -8,7 +8,7 @@ class Box(Container):
     """The Box component is a generic container for grouping other components.
     It's a fundamental building block. Think of it as an HTML `<div>` element.
 
-    Use the `style` attribute how to layout the box and its child components.
+    Use the `style` attribute to layout the box and its child components.
     """
 
     component: str | None = None

chartlets.py/chartlets/components/typography.py

@@ -9,7 +9,7 @@ class Typography(Component):
     and efficiently as possible."""
 
     text: str | None = None
-    """Optional text to be displayed."""
+    """Text to be displayed. Optional"""
 
     color: str | None = None
     """The color of the component."""