Add some missing docstrings

Author: apdavison

pipeline/src/base.py

@@ -14,6 +14,10 @@
 
 
 class Node(metaclass=Registry):
+    """
+    Base class for a metadata node
+    """
+
     @property
     def uuid(self):
         if self.id is not None:
@@ -29,7 +33,7 @@ def has_property(self, name):
 
     def to_jsonld(self, include_empty_properties=True, embed_linked_nodes=True, with_context=True):
         """
-        docstring goes here
+        Return a represention of this metadata node as a dictionary that can be directly serialized to JSON-LD.
         """
 
         def value_to_jsonld(value):
@@ -77,7 +81,7 @@ def value_to_jsonld(value):
     @classmethod
     def from_jsonld(cls, data):
         """
-        docstring goes here
+        Create a Python object representing a metadata node from a JSON-LD-compatible dictionary
         """
         data_copy = data.copy()
         context = data_copy.pop("@context", None)
@@ -141,7 +145,7 @@ def links(self):
 
 class LinkedMetadata(Node):
     """
-    docstring goes here
+    A Python representation of a metadata node that should have a unique identifier.
     """
 
     def __init__(self, id=None, **properties):
@@ -151,15 +155,15 @@ def __init__(self, id=None, **properties):
 
     def save(self, file_path, indent=2):
         """
-        docstring goes here
+        Save this object to a file in JSON-LD format
         """
         with open(file_path, "w") as output_file:
             json.dump(self.to_jsonld(), output_file, indent=indent)
 
     @classmethod
     def load(cls, file_path):
         """
-        docstring goes here
+        Create a Python object representing a metadata node from a JSON-LD file
         """
         with open(file_path, "r") as input_file:
             data = json.load(input_file)
@@ -168,7 +172,8 @@ def load(cls, file_path):
 
 class EmbeddedMetadata(Node):
     """
-    docstring goes here
+    A Python representation of a metadata node that should only be embedded within another node,
+    and should not have a unique identifier.
     """
 
     def __init__(self, **properties):
@@ -177,6 +182,10 @@ def __init__(self, **properties):
 
 
 class IRI:
+    """
+    Representation of an Internationalized Resource Identifier
+    """
+
     def __init__(self, value: Union[str, IRI]):
         if isinstance(value, IRI):
             iri = value.value