Skip to content

Commit

Permalink
DOC: Rework docstrings a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
HaoZeke committed Aug 13, 2023
1 parent 1e2a645 commit 1d45a0f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/source/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This section describes some things that may be of interest to
developers and other people interested in internals of ``asv``.

.. note::

From version 0.6 on-wards, functionality in ``asv`` has been split into the
section needed by the code being benchmarked (``asv_runner``) and the rest of
``asv``. This means that the ``asv`` documentation covers setting up
Expand Down
7 changes: 4 additions & 3 deletions docs/source/writing_benchmarks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,10 @@ value is the maximum of the timeouts of the benchmarks using it.

.. note::

From version 0.6 onwards, the configuration option
``default_benchmark_timeout`` can also be set for a project-wide
timeout.
.. versionchanged:: 0.6

The configuration option ``default_benchmark_timeout``
can also be set for a project-wide timeout.

.. _benchmark-attributes:

Expand Down

0 comments on commit 1d45a0f

Please sign in to comment.