From cf99315b0c67a0defe1eb41283bcea7eed521920 Mon Sep 17 00:00:00 2001
From: Ben Dichter <ben.dichter@gmail.com>
Date: Wed, 27 Nov 2024 17:26:13 -0500
Subject: [PATCH] add missing api docs (#420)

---
 docs/api/checks.rst                          |  8 +++++
 docs/best_practices/best_practices_index.rst |  1 +
 docs/best_practices/images.rst               | 32 ++++++++++++++++++++
 3 files changed, 41 insertions(+)
 create mode 100644 docs/best_practices/images.rst

diff --git a/docs/api/checks.rst b/docs/api/checks.rst
index d15cd6bfb..539970dfb 100644
--- a/docs/api/checks.rst
+++ b/docs/api/checks.rst
@@ -8,6 +8,10 @@ NWBFile Metadata
 ----------------
 .. automodule:: nwbinspector.checks._nwbfile_metadata
 
+General
+-------
+.. automodule:: nwbinspector.checks._general
+
 NWB Containers
 --------------
 .. automodule:: nwbinspector.checks._nwb_containers
@@ -43,3 +47,7 @@ Optogenetics (ogen)
 ImageSeries
 -----------
 .. automodule:: nwbinspector.checks._image_series
+
+Images
+------
+.. automodule:: nwbinspector.checks._images
diff --git a/docs/best_practices/best_practices_index.rst b/docs/best_practices/best_practices_index.rst
index 25632460c..cba58e22e 100644
--- a/docs/best_practices/best_practices_index.rst
+++ b/docs/best_practices/best_practices_index.rst
@@ -29,5 +29,6 @@ Authors: Oliver Ruebel, Andrew Tritt, Ryan Ly, Cody Baker and Ben Dichter
    ophys
    ogen
    image_series
+   images
    simulated_data
    extensions
diff --git a/docs/best_practices/images.rst b/docs/best_practices/images.rst
new file mode 100644
index 000000000..90d674240
--- /dev/null
+++ b/docs/best_practices/images.rst
@@ -0,0 +1,32 @@
+Images
+======
+
+Storage of Images
+-----------------
+
+.. _best_practice_order_of_images_unique:
+.. _best_practice_order_of_images_len:
+
+Storing the order of images in an Images object
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``order_of_images`` field of an :ref:`nwb-schema:sec-Images` object is designed to contain the order
+of the images in the ``images`` field of the :ref:`nwb-schema:sec-Images` object. As such, all of the values
+in the ``order_of_images`` field should be unique, and its length should be equal to the number of
+:ref:`nwb-schema:sec-Image` objects in the :ref:`nwb-schema:sec-Images` object.
+
+Check functions: :py:meth:`~nwbinspector.checks._images.check_order_of_images_unique` and
+:py:meth:`~nwbinspector.checks._images.check_order_of_images_len`
+
+
+.. _best_practice_index_series_points_to_image:
+
+Use of IndexSeries
+~~~~~~~~~~~~~~~~~~
+
+The use of an :ref:`nwb-schema:sec-IndexSeries` object to point to a :ref:`nwb-schema:sec-TimeSeries` will
+be deprecated in a future release of the NWB schema. The :ref:`nwb-schema:sec-IndexSeries` object should
+point to an :ref:`nwb-schema:sec-Images` container, which holds a collection of :ref:`nwb-schema:sec-Image`
+objects instead.
+
+Check function: :py:meth:`~nwbinspector.checks._images.check_index_series_points_to_image`