Skip to content

Commit 1937408

Browse files
authored
Merge pull request #1371 from CodyCBakerPhD/remove_asv_dev_docs
Remove `asv dev` from docs
2 parents 6b475f7 + 12ccff0 commit 1937408

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

docs/source/using.rst

-4
Original file line numberDiff line numberDiff line change
@@ -303,10 +303,6 @@ for this machine::
303303

304304
.. note::
305305

306-
There is a special version of ``asv run`` that is useful when
307-
developing benchmarks, called ``asv dev``. See
308-
:ref:`writing-benchmarks` for more information.
309-
310306
You can also do a validity check for the benchmark suite without
311307
running benchmarks, using ``asv check``.
312308

docs/source/writing_benchmarks.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,14 @@ that your benchmarks may produce, pass the ``--show-stderr`` flag::
5959

6060
asv run --show-stderr
6161

62-
Finally, there is a special command, ``asv dev``, that uses all of
63-
these features and is equivalent to::
62+
Finally, a quick way to test out the benchmark suite before doing a full run is to use all of
63+
these features together with::
6464

6565
asv run --python=same --quick --show-stderr --dry-run
6666

67+
.. versionchanged:: 0.6.0
68+
This replaces the now removed ``asv dev`` command.
69+
6770
You may also want to only do a basic check whether the benchmark suite
6871
is well-formatted, without actually running any benchmarks::
6972

0 commit comments

Comments
 (0)