Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jni opened this issue Jun 18, 2024 · 1 comment
Open

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

jni opened this issue Jun 18, 2024 · 1 comment
Labels
bug Something isn't working content Ideas for new or improved content

Comments

@jni
Copy link
Member

jni commented Jun 18, 2024

πŸ› 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.

@jni jni added the bug Something isn't working label Jun 18, 2024
@Czaki
Copy link
Contributor

Czaki commented Jun 18, 2024

My suggestion to command that should be used is here napari/napari#6998 (comment)

@melissawm melissawm added the content Ideas for new or improved content label Jun 18, 2024
@melissawm melissawm moved this to Prioritized in Documentation Working Group Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working content Ideas for new or improved content
Projects
Status: Prioritized
Development

No branches or pull requests

3 participants