Documentation for Shape class

cmccomb · Dec 30, 2023 · 262bfd7 · 262bfd7
1 parent 1e7f55e
commit 262bfd7
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/trussme/components.py b/trussme/components.py
@@ -52,14 +52,38 @@ def __init__(self):
 
     @abc.abstractmethod
     def moi(self) -> float:
+        """
+        The moment of inertia of the shape
+
+        Returns
+        -------
+        float
+            The moment of inertia of the shape
+        """
         pass
 
     @abc.abstractmethod
     def area(self) -> float:
+        """
+        The cross-sectional area of the shape
+
+        Returns
+        -------
+        float
+            The cross-sectional area of the shape
+        """
         pass
 
     @abc.abstractmethod
     def name(self) -> str:
+        """
+        The name of the shape
+
+        Returns
+        -------
+        str
+            The name of the shape
+        """
         pass