Standardize docstrings for improved clarity

Updated docstrings in convert_intervals.py, convert_rec_header.py, convert_yaml.py, and metadata_validation.py to use consistent formatting, capitalization, and parameter descriptions. This improves code readability and documentation quality.

Author: edeno

src/trodes_to_nwb/convert_intervals.py

@@ -20,20 +20,16 @@ def add_epochs(
     session_df: pd.DataFrame,
     neo_io: list[SpikeGadgetsRawIO],
 ):
-    """add epochs to nwbfile
+    """Add epochs to nwbfile.
 
     Parameters
     ----------
     nwbfile : NWBFile
-        nwbfle to add epochs to
-    file_info : pd.DataFrame
-        dataframe with file info
-    date : int
-        date of session
-    animal : str
-        animal name
-    neo_io: List[SpikeGadgetsRawIO]
-        neo_io iterators for each rec file. Contains time information
+        NWB file to add epochs to.
+    session_df : pd.DataFrame
+        DataFrame with session file information.
+    neo_io : list[SpikeGadgetsRawIO]
+        List of neo_io iterators for each rec file. Contains time information.
     """
     logger = logging.getLogger("convert")
     for epoch in set(session_df.epoch):

src/trodes_to_nwb/convert_rec_header.py

@@ -12,22 +12,22 @@
 
 
 def read_header(recfile: Path | str) -> ElementTree.Element:
-    """Read xml header from rec file
+    """Read XML header from rec file.
 
     Parameters
     ----------
-    recfile : Path
-        Path to rec file
+    recfile : Path or str
+        Path to rec file.
 
     Returns
     -------
     ElementTree.Element
-        xml header
+        XML header element.
 
     Raises
     ------
     ValueError
-        If the xml header does not contain '</Configuration>'
+        If the XML header does not contain '</Configuration>'.
     """
     header_size = None
     with open(recfile, mode="rb") as f:

src/trodes_to_nwb/convert_yaml.py

@@ -33,20 +33,20 @@ def load_metadata(
     metadata_path: str,
     device_metadata_paths: list[str],
 ) -> tuple[dict, list[dict]]:
-    """loads metadata files as dictionaries
+    """Loads metadata files as dictionaries.
 
     Parameters
     ----------
     metadata_path : str
-        path to file made by yaml generator
+        Path to file made by yaml generator.
     device_metadata_paths : list[str]
-        list of paths to yaml files with information on standard devices (e.g. probes,
-        optical fibers, viruses)
+        List of paths to yaml files with information on standard devices (e.g. probes,
+        optical fibers, viruses).
 
     Returns
     -------
     tuple[dict, list[dict]]
-        the yaml generator metadata and list of device metadatas
+        The yaml generator metadata and list of device metadatas.
     """
     metadata = None
     with open(metadata_path) as stream:

src/trodes_to_nwb/metadata_validation.py

@@ -11,12 +11,12 @@
 
 
 def _get_nwb_json_schema_path() -> str:
-    """Get the NWB JSON Schema file path
+    """Get the NWB JSON Schema file path.
 
     Returns
     -------
     str
-        NWB Schema file Path
+        NWB Schema file path.
     """
     return str((Path(__file__).parent / "nwb_schema.json").resolve())