Skip to content

Commit

Permalink
Remove outdated docstring from test_montecarlo.py (#2382)
Browse files Browse the repository at this point in the history
Remove outdated docstring
  • Loading branch information
chvogl authored Aug 4, 2023
1 parent 97a78ba commit 7f78731
Showing 1 changed file with 0 additions and 46 deletions.
46 changes: 0 additions & 46 deletions tardis/montecarlo/tests/test_montecarlo.py
Original file line number Diff line number Diff line change
@@ -1,49 +1,3 @@
"""
Unit tests for methods in `tardis/montecarlo/src/cmontecarlo.c`.
* `ctypes` library is used to wrap C methods and expose them to python.
Probable Reasons for Failing Tests:
-----------------------------------
1. Change made in C struct declarations:
- Reflect the changes done in C structs, into Python counterparts.
- Check **tardis/montecarlo/struct.py**.
2. Return type of any method changed:
- Modify the `restype` parameter in the test method here.
- For example:
```
clib.rpacket_doppler_factor.restype = c_double
```
3. Underlying logic modified:
- Check whether the changes made in C method are logically correct.
- If the changes made were correct and necessary, update the corresponding
test case.
General Test Design Procedure:
------------------------------
Please follow this design procedure while adding a new test:
1. Parametrization as per desire of code coverage.
- C tests have different flows controlled by conditional statements.
Parameters checked in conditions can be provided in different testcases.
- Keep consistency with variable names as (in order):
- `packet_params`
- `model_params`
- `expected_params` (`expected` if only one value to be asserted.)
- Suggested variable names can be compromised if readability of the test
increases.
2. Test Method body:
- Keep name as `test_` + `(name of C method)`.
- Refer to method `test_rpacket_doppler_factor` below for description.
"""


import os
import pytest
import numpy as np
Expand Down

0 comments on commit 7f78731

Please sign in to comment.