Add additional docstrings to dict_parsing.py

src/astra/data/dict_parsing.py

@@ -57,6 +57,11 @@ def add(self, element: int | str) -> 'Path':
         return Path(self.base, self.elements + [element])
 
     def __str__(self):
+        """
+        Format this path in a human-readable way.
+
+        Current format looks something like: base[index0].key0[index1][index2].key1.key2
+        """
         return self.base + ''.join(
             (f'[{element}]' if isinstance(element, int) else f'.{element}')
             for element in self.elements
@@ -102,6 +107,17 @@ class PathedList:
     _list: list
 
     def __init__(self, path: Path, value: object):
+        """
+        Construct a PathedList.
+
+        :param path:
+            The path for the PathedList.
+        :param value:
+            The underlying list for the PathedList, validated as a list during runtime.
+
+        :raise ParsingError:
+            If value is not a list.
+        """
         self._path = path
         self._list = _check_type(path, value, list)
 
@@ -166,6 +182,17 @@ class PathedDict:
     _dict: dict
 
     def __init__(self, path: Path, value: object):
+        """
+        Construct a PathedDict.
+
+        :param path:
+            The path for the PathedDict.
+        :param value:
+            The underlying dict for the PathedDict, validated as a dict during runtime.
+
+        :raise ParsingError:
+            If value is not a dict.
+        """
         self._path = path
         self._dict = _check_type(path, value, dict)