Skip to content

Commit

Permalink
upd: HACKING.md [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
chaimleib committed Dec 31, 2014
1 parent 75c4e79 commit b7fe8cb
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ The `intervaltree` directory has three main files:

All files ending with `_test.py` are detected and run whenever you run `make` or `make quicktest`. In those files, only functions beginning with `test_` are executed.

#### `test/data`
Some tests depend on having certain lists of `Interval`s. These are stored in the modules of `test/data`. Most of these modules only contain a `data` attribute, which is a list of tuples that is converted to a list of `Interval`s by `test/intervals.py`. You can access them by importing the dict of lists of `Interval`s `test.intervals.ivs`.

Other tests (like `test/issue25_test.py`) depend on having pre-constructed `IntervalTree`s. These are constructed by `test/intervaltrees.py` and can be accessed by importing `test.intervaltrees.trees`. This is a dict of callables that return `IntervalTree`s.

### `scripts`

Contains `testall.sh`, which runs all tests on all supported versions of Python.
Expand Down

0 comments on commit b7fe8cb

Please sign in to comment.