Merge pull request #501 from oist/roi-edit-description

[#493] Edit roiによるNWBファイルの変更内容を明記

Makefile

@@ -57,4 +57,9 @@ test_pypi:
 
 .PHONY: push_pypi
 push_pypi:
-	twine upload --repository pypi dist/*
+	twine upload --repository pypi dist/*
+
+.PHONY: test_doc
+test_doc:
+	python3 -m pip install -r docs/requirements.txt
+	sphinx-autobuild -b html docs docs/_build --port 8001

docs/gui/visualize.md

@@ -161,6 +161,48 @@ Press <strong>OK</strong> or <strong>Cancel</strong> button to Add or No
 Or click on each cell ROI to delete ROI or merge ROIs (when you select 2 or more ROI cells)
 Press <strong>Merge ROI</strong> or <strong>Delete ROI</strong> or <strong>Cancel</strong> button to Merge or Delete or No.
 
+NWB file is overwirtten with the ROI edit information.
+
+```{eval-rst}
+.. note::
+  ROI edit information in NWB file
+
+  - common
+
+      - edited ROI ids are recorded in processing/optinist section
+
+  - specific
+
+      - merge
+
+          - iscell data of ROIs to be merged changes to False
+          - ROI after merge are added with new ID
+
+      - delete
+
+          - iscell data of deleted ROI changes to False.
+```
+
+```{eval-rst}
+.. note::
+  ROI's id and index of viewer have different values!
+
+  - id
+
+      - The id of ROI, **starting from 1**.
+      - Shown in
+
+          - VISUALIZE tab.
+          - NWBfile's processing/optinist section.
+
+  - index
+
+      - Numbering of columns and rows in tables, **starting from 0**.
+      - Shown in
+
+          - table when you open NWBfile's timecourse data with viewers like `HDFView <https://www.hdfgroup.org/downloads/hdfview/>`_
+```
+
 
 ## saving plots