From 6941e03f644f489f478e99732d190246d0106b40 Mon Sep 17 00:00:00 2001 From: "Christian Y. Brenninkmeijer" Date: Wed, 3 Jan 2024 10:24:19 +0000 Subject: [PATCH] module docstring --- README.md | 6 +++--- spinnaker_testbase/__init__.py | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 60669e7..7e4c189 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/spinnaker_testbase/__init__.py b/spinnaker_testbase/__init__.py index 2d8b5aa..148bd8c 100644 --- a/spinnaker_testbase/__init__.py +++ b/spinnaker_testbase/__init__.py @@ -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