search

napari / docs

Documentation for napari (other than API docs)
BSD 3-Clause "New" or "Revised" License
11 stars 36 forks source link

asv dev is deprecated so we should update our benchmarks docs #428

Open jni opened 3 months ago

jni commented 3 months ago

🐛 Bug

Our docs recommend using asv dev, but the asv dev is deprecated and no longer runs — it just outputs the (actually very helpful) deprecation message:

RuntimeError: asv dev has been removed. It was a shortcut of asv run, which you can use instead. It was removed because it caused confusion, in particular after changing what it was running in asv 0.5.x

You can be interested in the next asv run arguments:

  • --python=same: to use the current environment and not create one
  • --quick: to run benchmarks just once
  • --dry-run: to not save the results

So we should update our docs to match.

Czaki commented 3 months ago

My suggestion to command that should be used is here https://github.com/napari/napari/pull/6998#issuecomment-2175530893