Add module docstrings

Author: christopher-wild

causal_testing/data_collection/data_collector.py

@@ -1,3 +1,6 @@
+"""This module contains the DataCollector abstract class, as well as its concrete extensions: ExperimentalDataCollector
+and ObservationalDataCollector"""
+
 import logging
 from abc import ABC, abstractmethod
 from enum import Enum

causal_testing/generation/abstract_causal_test_case.py

@@ -1,3 +1,4 @@
+"""This module contains the class AbstractCausalTestCase, which generates concrete test cases"""
 import itertools
 import logging
 from enum import Enum

causal_testing/json_front/json_class.py

@@ -1,3 +1,5 @@
+"""This module contains the JsonUtility class, details of using this class can be found here:
+https://causal-testing-framework.readthedocs.io/en/latest/json_front_end.html"""
 import argparse
 import json
 import logging

causal_testing/specification/causal_dag.py

@@ -1,3 +1,5 @@
+"""This module contains the CausalDAG class, as well as the functions list_all_min_sep and close_seperator"""
+
 from __future__ import annotations
 
 import logging

causal_testing/specification/causal_specification.py

@@ -1,4 +1,5 @@
-import logging
+"""This module holds the abstract CausalSpecification data class, which holds a Scenario and CausalDag"""
+
 from abc import ABC
 from dataclasses import dataclass
 from typing import Union
@@ -7,7 +8,6 @@
 from causal_testing.specification.scenario import Scenario
 
 Node = Union[str, int]  # Node type hint: A node is a string or an int
-logger = logging.getLogger(__name__)
 
 
 @dataclass

causal_testing/specification/scenario.py

@@ -1,3 +1,4 @@
+"""This module holds the Scenario Class"""
 from collections.abc import Iterable, Mapping
 
 from tabulate import tabulate

causal_testing/specification/variable.py

@@ -1,3 +1,6 @@
+"""This module contains the Variable abstract class, as well as its concrete extensions: Input, Output and Meta. The
+function z3_types and the private function _coerce are also in this module."""
+
 from __future__ import annotations
 from abc import ABC
 from collections.abc import Callable

causal_testing/testing/base_test_case.py

@@ -1,3 +1,4 @@
+"""This module contains the BaseTestCase dataclass, which stores the information required for identification"""
 from dataclasses import dataclass
 from causal_testing.specification.variable import Variable
 from causal_testing.testing.effect import Effect

causal_testing/testing/causal_test_case.py

@@ -1,3 +1,4 @@
+"""This module contains the CausalTestCase class, a class that holds the information required for a causal test"""
 import logging
 from typing import Any
 

causal_testing/testing/causal_test_engine.py

@@ -1,3 +1,5 @@
+"""This module contains the CausalTestEngine class, a class responsible for the execution of causal tests"""
+
 import logging
 
 from causal_testing.data_collection.data_collector import DataCollector