docstrings + formatting

CentreForDigitalHumanities · Dec 12, 2024 · 860349c · 860349c
1 parent 9618451
commit 860349c
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/backend/collect/api.py b/backend/collect/api.py
@@ -61,4 +61,4 @@ def get_graph(self, request: Request, collection: str, **kwargs) -> Graph:
         g += collection_obj._class_triples()
         g += EDPOPCollection.records._stored_triples(collection_obj)
 
-        return g
+        return g
diff --git a/backend/collect/graphs.py b/backend/collect/graphs.py
@@ -28,6 +28,13 @@ def list_to_graph_collection(items: List[Node], items_node: IdentifiedNode) -> G
 
 
 def collection_triples(graph: Graph, list_node: IdentifiedNode) -> Triples:
+    '''
+    Select all triples that make up an RDF collection in a graph.
+    
+    This collects the chain of `rdf:first` / `rdf:rest` relations that make up the
+    collection.
+    '''
+
     triples = list(graph.triples((list_node, RDF.first, None)))
     triples += list(graph.triples((list_node, RDF.rest, None)))
 

diff --git a/backend/collect/rdf_models.py b/backend/collect/rdf_models.py
@@ -10,6 +10,10 @@
 )
 
 class CollectionMembersField(RDFField):
+    '''
+    Field for the records that are contained in an EDPOP collection.
+    '''
+
     def get(self, instance: RDFModel):
         g = self.get_graph(instance)
         items = next(g.objects(instance.uri, AS.items), None)