Interesting jeje

Author: cetagostini

pymc_marketing/mmm/causal.py

@@ -844,7 +844,12 @@ def get_test_results(self, x: str, y: str) -> list[dict[str, float]]:
         ]
 
     def summary(self) -> str:
-        """Return a human-readable summary of edges and number of CI tests."""
+        """Return a summary of edges and number of CI tests.
+
+        .. code-block:: python
+
+            print(model.summary())
+        """
         lines = ["=== Directed edges ==="]
         for u, v in self.get_directed_edges():
             lines.append(f"{u} -> {v}")
@@ -1213,6 +1218,12 @@ def get_undirected_edges(self) -> list[tuple[str, str]]:
         return sorted(self._adj_undirected)
 
     def summary(self) -> str:
+        """Return a summary of edges and number of CI tests.
+
+        .. code-block:: python
+
+            print(model.summary())
+        """
         lines = ["=== Directed edges ==="]
         for u, v in self.get_directed_edges():
             lines.append(f"{u} -> {v}")