fix API docs

src/nwbinspector/checks/_ecephys.py

@@ -50,7 +50,11 @@ def check_electrical_series_dims(electrical_series: ElectricalSeries):
 
 @register_check(importance=Importance.BEST_PRACTICE_VIOLATION, neurodata_type=ElectricalSeries)
 def check_electrical_series_reference_electrodes_table(electrical_series: ElectricalSeries):
-    """Check that the 'electrodes' of an ElectricalSeries references the ElectrodesTable."""
+    """
+    Check that the 'electrodes' of an ElectricalSeries references the ElectrodesTable.
+
+    Best Practice: TODO
+    """
     if electrical_series.electrodes.table.name != "electrodes":
         return InspectorMessage(message="electrodes does not  reference an electrodes table.")
 

src/nwbinspector/checks/_icephys.py

@@ -7,6 +7,10 @@
 
 @register_check(importance=Importance.BEST_PRACTICE_VIOLATION, neurodata_type=IntracellularElectrode)
 def check_intracellular_electrode_cell_id_exists(intracellular_electrode: IntracellularElectrode):
-    """Check if the IntracellularElectrode contains a cell_id."""
+    """
+    Check if the IntracellularElectrode contains a cell_id.
+
+    Best Practice: TODO
+    """
     if hasattr(intracellular_electrode, "cell_id") and intracellular_electrode.cell_id is None:
         return InspectorMessage(message="Please include a unique cell_id associated with this IntracellularElectrode.")

src/nwbinspector/checks/_ophys.py

@@ -42,7 +42,11 @@ def check_roi_response_series_dims(roi_response_series: RoiResponseSeries):
 def check_roi_response_series_link_to_plane_segmentation(
     roi_response_series: RoiResponseSeries,
 ):
-    """Check that each ROI response series links to a plane segmentation."""
+    """
+    Check that each ROI response series links to a plane segmentation.
+
+    Best Practice: TODO
+    """
     if not isinstance(roi_response_series.rois.table, PlaneSegmentation):
         return InspectorMessage(message="rois field does not point to a PlaneSegmentation table.")