docs

SpiNNakerManchester · Dec 3, 2024 · 7e18415 · 7e18415
1 parent 0d97058
commit 7e18415
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/spinn_front_end_common/interface/buffer_management/storage_objects/buffer_database.py b/spinn_front_end_common/interface/buffer_management/storage_objects/buffer_database.py
@@ -48,7 +48,7 @@ class BufferDatabase(BaseDatabase):
     @classmethod
     def reset_db(cls, reset_number: int) -> "BufferDatabase":
         """
-        Retrieves a NeoBufferDatabase for this segment.
+        Retrieves a BufferDatabase for this segment.
         """
         database_file = cls.reset_file(reset_number)
         return BufferDatabase(database_file)

diff --git a/spinn_front_end_common/interface/provenance/provenance_reader.py b/spinn_front_end_common/interface/provenance/provenance_reader.py
@@ -79,7 +79,7 @@ def __init__(self, provenance_data_path: Optional[str] = None):
     @classmethod
     def reset_db(cls, reset_number: int) -> "ProvenanceReader":
         """
-        Retrieves a NeoBufferDatabase for this segment.
+        Retrieves a ProvenanceReader for this segment.
         """
         database_file = cls.reset_file(reset_number)
         return ProvenanceReader(database_file)

diff --git a/spinn_front_end_common/utilities/base_database.py b/spinn_front_end_common/utilities/base_database.py
@@ -74,6 +74,9 @@ def __init__(self, database_file: Optional[str] = None, *,
 
     @classmethod
     def reset_file(cls, reset_number) -> str:
+        """
+        Provides the database file uses during this reset
+        """
         return reset_cache[reset_number]
 
     @classmethod