Skip to content

Commit a8e9fbd

Browse files
committed
module name change in readme.
1 parent 5009ce2 commit a8e9fbd

File tree

1 file changed

+1
-25
lines changed

1 file changed

+1
-25
lines changed

validator/README.md

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ the module and produce the output datasets (by default, in `receiving`), run
3131
the following:
3232

3333
```
34-
env/bin/python -m delphi_NAME
34+
env/bin/python -m delphi_validator
3535
```
3636

3737
Once you are finished with the code, you can deactivate the virtual environment
@@ -41,27 +41,3 @@ and (optionally) remove the environment itself.
4141
deactivate
4242
rm -r env
4343
```
44-
45-
## Testing the code
46-
47-
To do a static test of the code style, it is recommended to run **pylint** on
48-
the module. To do this, run the following from the main module directory:
49-
50-
```
51-
env/bin/pylint delphi_NAME
52-
```
53-
54-
The most aggressive checks are turned off; only relatively important issues
55-
should be raised and they should be manually checked (or better, fixed).
56-
57-
Unit tests are also included in the module. To execute these, run the following
58-
command from this directory:
59-
60-
```
61-
(cd tests && ../env/bin/pytest --cov=delphi_NAME --cov-report=term-missing)
62-
```
63-
64-
The output will show the number of unit tests that passed and failed, along
65-
with the percentage of code covered by the tests. None of the tests should
66-
fail and the code lines that are not covered by unit tests should be small and
67-
should not include critical sub-routines.

0 commit comments

Comments
 (0)