From c9563f450c8b8a559e14857d35d12898fdb3a1e1 Mon Sep 17 00:00:00 2001 From: Tilo Reneau-Cardoso <67246777+TiloRC@users.noreply.github.com> Date: Sat, 14 Dec 2024 18:16:36 -0800 Subject: [PATCH] readme: fixed commands and grammar --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 37d0906..4508554 100644 --- a/README.rst +++ b/README.rst @@ -42,7 +42,7 @@ or in conda environment, use $ conda install -c conda-forge asv -If you're not using conda, you also needs to have ``virtualenv`` +If you're not using conda, you also need to have ``virtualenv`` installed. :: @@ -52,20 +52,20 @@ installed. Running the benchmarks ^^^^^^^^^^^^^^^^^^^^^^ -To quickly try out the benchmarks (e.g. while developing a new benchmark -you can run it against a single commit on sympy master: +To quickly try out the benchmarks (e.g., while developing a new benchmark), +you can run it against a single commit on SymPy master. :: - $ asv --quick "HEAD^!" + $ asv run --quick "HEAD^!" -If you work with ``conda`` , you should change the +If you work with ``conda``, you should change the ``"environment_type"`` entry in ``asv.conf.json`` from ``"virtualenv"`` to ``"conda"``. Or you can use, :: - $ asv --config asv.conf.conda.json --quick "HEAD^!" + $ asv run --config asv.conf.conda.json --quick "HEAD^!" You can also run a specific benchmark based on the function or class name in ``benchmarks/`` or ``slow_benchmarks/`` folder.