Skip to content

Commit 01f7cfa

Browse files
authored
Merge pull request #1467 from JuroOravec/patch-1
docs: document the `version` field in `asv.conf.json.rst`
2 parents 16a6f62 + 69946d3 commit 01f7cfa

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

docs/source/asv.conf.json.rst

+4
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ this file and their expected values.
2222

2323
.. only:: not man
2424

25+
``version``
26+
-----------
27+
Version of the `asv.conf.json` spec. Currently only `1`.
28+
2529
``project``
2630
-----------
2731
The name of the project being benchmarked.

docs/source/using.rst

+2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ do, and there is also a :ref:`conf-reference` with more details. The
5555
values that will most likely need to be changed for any benchmarking
5656
suite are:
5757

58+
- ``version``: Version of the `asv.conf.json` spec. As of `v0.6.4`, there is only version `1`.
59+
5860
- ``project``: The Python package name of the project being benchmarked.
5961

6062
- ``project_url``: The project's homepage.

0 commit comments

Comments
 (0)