Skip to content

Commit

Permalink
module docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Christian-B committed Jan 3, 2024
1 parent 0aa2d8c commit 6941e03
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[![Python Actions](https://github.com/SpiNNakerManchester/TestBase/actions/workflows/python_actions.yml/badge.svg?branch=main)](https://github.com/SpiNNakerManchester/TestBase/actions/workflows/python_actions.yml) [![Coverage Status](https://coveralls.io/repos/github/SpiNNakerManchester/TestBase/badge.svg)](https://coveralls.io/github/SpiNNakerManchester/TestBase)

This Repository hold classes and script used for integration tests
This Repository hold classes and script used for unit and integration tests

There is need to use this repository unless you want to run some or all integration tests locally
There is need to use this repository unless you want to run some or all tests locally

Documentation
-------------
[TestBase documentation](https://spinnakertestbase.readthedocs.io/)

[Combined PyNN8 python documentation (Excluding TestBase)](http://spinnakermanchester.readthedocs.io)
[Combined python documentation (Excluding TestBase)](http://spinnakermanchester.readthedocs.io)

7 changes: 7 additions & 0 deletions spinnaker_testbase/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""
This Repository hold classes and script used for unit and integration tests
There is need to use this repository unless you want to run some or all tests
locally
"""

from .base_test_case import BaseTestCase
from .root_script_builder import RootScriptBuilder
from .script_checker import ScriptChecker
Expand Down

0 comments on commit 6941e03

Please sign in to comment.