chore(plot-spikes): document sonata spike reader func

NeuroML · Nov 7, 2023 · f868ab6 · f868ab6
1 parent 50e4483
commit f868ab6
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/pyneuroml/plot/PlotSpikes.py b/pyneuroml/plot/PlotSpikes.py
@@ -112,7 +112,12 @@ def main(args=None):
     run(a=args)
 
 
-def read_sonata_spikes_hdf5_file(file_name):
+def read_sonata_spikes_hdf5_file(file_name: str):
+    """Read a sonata HDF5 file with spike data
+
+    :param file_name: name of file to read
+    :type file_name: str
+    """
     full_path = os.path.abspath(file_name)
     logger.info("Loading SONATA spike times from: %s (%s)" % (file_name, full_path))