doc/requirements.rst
.. highlight:: shell
.. _requirements:
===============================================
Requirements for snappysonic
===============================================
This is the software requirements file for snappysonic, part of the
SciKit-Surgery project. The requirements listed below should define
what snappysonic does. Each requirement can be matched to a unit test that
checks whether the requirement is met.
Requirements
~~~~~~~~~~~~
+------------+--------------------------------------------------------+-------------------------------------+
| ID | Description | Test |
+============+========================================================+=====================================+
| 0000 | Module has a help page | pylint, see |
| | | tests/pylint.rc and tox.ini |
+------------+--------------------------------------------------------+-------------------------------------+
| 0001 | Functions are documented | pylint, see |
| | | tests/pylint.rc and tox.ini |
+------------+--------------------------------------------------------+-------------------------------------+
| 0002 | Package has a version number | No test yet, handled by git. |
+------------+--------------------------------------------------------+-------------------------------------+