Skip to content

Commit 0079255

Browse files
committed
DOC: Update benchmark docstrings
1 parent 6dc8f0f commit 0079255

File tree

6 files changed

+12
-36
lines changed

6 files changed

+12
-36
lines changed

nibabel/benchmarks/bench_array_to_file.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55
import nibabel as nib
66
nib.bench()
77
8-
If you have doctests enabled by default in nose (with a noserc file or
9-
environment variable), and you have a numpy version <= 1.6.1, this will also
10-
run the doctests, let's hope they pass.
8+
Run this benchmark with::
119
12-
Run this benchmark with:
13-
14-
nosetests -s --match '(?:^|[\\b_\\.//-])[Bb]ench' /path/to/bench_load_save.py
10+
pytest -c <path>/benchmarks/pytest.benchmark.ini <path>/benchmarks/bench_load_save.py
1511
"""
1612

1713
import sys

nibabel/benchmarks/bench_arrayproxy_slicing.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55
import nibabel as nib
66
nib.bench()
77
8-
If you have doctests enabled by default in nose (with a noserc file or
9-
environment variable), and you have a numpy version <= 1.6.1, this will also
10-
run the doctests, let's hope they pass.
8+
Run this benchmark with::
119
12-
Run this benchmark with:
13-
14-
nosetests -s --match '(?:^|[\\b_\\.//-])[Bb]ench' /path/to/bench_arrayproxy_slicing.py
10+
pytest -c <path>/benchmarks/pytest.benchmark.ini <path>/benchmarks/bench_arrayproxy_slicing.py
1511
"""
1612

1713
from timeit import timeit

nibabel/benchmarks/bench_fileslice.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,9 @@
33
import nibabel as nib
44
nib.bench()
55
6-
If you have doctests enabled by default in nose (with a noserc file or
7-
environment variable), and you have a numpy version <= 1.6.1, this will also
8-
run the doctests, let's hope they pass.
6+
Run this benchmark with::
97
10-
Run this benchmark with:
11-
12-
nosetests -s --match '(?:^|[\\b_\\.//-])[Bb]ench' /path/to/bench_fileslice.py
8+
pytest -c <path>/benchmarks/pytest.benchmark.ini <path>/benchmarks/bench_fileslice.py
139
"""
1410

1511
import sys

nibabel/benchmarks/bench_finite_range.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55
import nibabel as nib
66
nib.bench()
77
8-
If you have doctests enabled by default in nose (with a noserc file or
9-
environment variable), and you have a numpy version <= 1.6.1, this will also
10-
run the doctests, let's hope they pass.
8+
Run this benchmark with::
119
12-
Run this benchmark with:
13-
14-
nosetests -s --match '(?:^|[\\b_\\.//-])[Bb]ench' /path/to/bench_finite_range
10+
pytest -c <path>/benchmarks/pytest.benchmark.ini <path>/benchmarks/bench_finite_range.py
1511
"""
1612

1713
import sys

nibabel/benchmarks/bench_load_save.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55
import nibabel as nib
66
nib.bench()
77
8-
If you have doctests enabled by default in nose (with a noserc file or
9-
environment variable), and you have a numpy version <= 1.6.1, this will also
10-
run the doctests, let's hope they pass.
8+
Run this benchmark with::
119
12-
Run this benchmark with:
13-
14-
nosetests -s --match '(?:^|[\\b_\\.//-])[Bb]ench' /path/to/bench_load_save.py
10+
pytest -c <path>/benchmarks/pytest.benchmark.ini <path>/benchmarks/bench_load_save.py
1511
"""
1612

1713
import sys

nibabel/benchmarks/bench_streamlines.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55
import nibabel as nib
66
nib.bench()
77
8-
If you have doctests enabled by default in nose (with a noserc file or
9-
environment variable), and you have a numpy version <= 1.6.1, this will also run
10-
the doctests, let's hope they pass.
8+
Run this benchmark with::
119
12-
Run this benchmark with:
13-
14-
nosetests -s --match '(?:^|[\\b_\\.//-])[Bb]ench' /path/to/bench_streamlines.py
10+
pytest -c <path>/benchmarks/pytest.benchmark.ini <path>/benchmarks/bench_streamlines.py
1511
"""
1612

1713
import numpy as np

0 commit comments

Comments
 (0)