tests: add example_class module

Author: machow

quartodoc/tests/example_class.py

@@ -0,0 +1,50 @@
+class C:
+    """The short summary.
+
+    The extended summary,
+    which may be multiple lines.
+
+    Parameters
+    ----------
+    x:
+        Uses signature type.
+    y: int
+        Uses manual type.
+
+    """
+
+    SOME_ATTRIBUTE: float
+    """An attribute"""
+
+    def __init__(self, x: str, y: int):
+        self.x = x
+        self.y = y
+        self.z: int = 1
+
+    def some_method(self):
+        """A method"""
+
+    @property
+    def some_property(self):
+        """A property"""
+
+
+class AttributesTable:
+    """The short summary.
+
+    Attributes
+    ----------
+    x:
+        Uses signature type
+    y: int
+        Uses manual type
+    z:
+        Defined in init
+    """
+
+    x: str
+    y: int
+    """This docstring should not be used"""
+
+    def __init__(self):
+        self.z: float = 1