Merge pull request #306 from NeuroML/feat/doc-sbml

Document sbml
NeuroML · Feb 19, 2024 · fff20f2 · fff20f2
2 parents eb91d94 + 78a042a
commit fff20f2
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/docs/source/pyneuroml.rst b/docs/source/pyneuroml.rst
@@ -26,5 +26,6 @@ The PyNeuroML package includes the following sub-packages:
    pyneuroml.povray
    pyneuroml.runners
    pyneuroml.swc
+   pyneuroml.sbml
    pyneuroml.tune
    pyneuroml.utils
diff --git a/docs/source/pyneuroml.sbml.rst b/docs/source/pyneuroml.sbml.rst
@@ -0,0 +1,7 @@
+pyneuroml.sbml module
+======================
+
+.. automodule:: pyneuroml.sbml
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/pyneuroml/sbml/__init__.py b/pyneuroml/sbml/__init__.py
@@ -11,10 +11,15 @@
 
 
 def validate_sbml_files(input_files: List[str], strict_units: bool = False) -> bool:
-    """
-    validate each input file using libsbml.SBMLDocument.checkConsistency
-    input_files is a list of one or more filepaths
-    strict_units converts unit consistency warnings into errors
+    """Validate input files using libsbml.SBMLDocument.checkConsistency
+
+    :param input_files: a list of one or more filepaths
+    :type input_files: list(str)
+    :param strict_units: toggle whether unit consistency warnings should be
+        treated as errors
+    :type strict_units: bool
+    :returns: True if all files are valid, else False
+    :rtype: bool
     """
 
     if not len(input_files) >= 1: