Add docstrings for Environment and Substitutions

jmanuel1 · Oct 20, 2024 · 8069270 · 8069270
1 parent 0dcf9d7
commit 8069270
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/concat/typecheck/env.py b/concat/typecheck/env.py
@@ -18,6 +18,8 @@
 
 
 class Environment(Mapping[str, 'Type']):
+    """A map from names in a typing context to the types of those names."""
+
     def __init__(self, env: Optional[Mapping[str, Type]] = None) -> None:
         self._env = env or {}
         self._sub_cache = dict[int, Environment]()

diff --git a/concat/typecheck/substitutions.py b/concat/typecheck/substitutions.py
@@ -33,6 +33,8 @@ def apply_substitution(self, sub: 'Substitutions') -> _Result:
 
 
 class Substitutions(Mapping['Variable', 'Type']):
+    """Substitutions of type variables with types."""
+
     __next_id = 0
 
     def __init__(