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

Update Use Cases to 0.2.0 #311

Merged
merged 5 commits into from
Nov 13, 2024
Merged

Update Use Cases to 0.2.0 #311

merged 5 commits into from
Nov 13, 2024

Conversation

gselzer
Copy link
Collaborator

@gselzer gselzer commented Nov 13, 2024

This PR updates all of the Use Cases with new graphics that reflect UI updates, but perhaps more importantly, they provide new admonitions at the start of each use case describing:

  • The exact Mamba environment used
  • The PyImageJ endpoint used
    image

@gselzer
Copy link
Collaborator Author

gselzer commented Nov 13, 2024

Notably, I did not update the napari-imagej benchmarks - we can do that in another PR down the line if necessary

@ctrueden
Copy link
Member

Thanks @gselzer! I like the new admonitions. One suggestion: write "Conda environment" rather than "Mamba environment", since the technology in question is Conda here; mamba is just the CLI tool that works with them.

As for the benchmarks, I think it's fine not to update them unless there was some significant infrastructure change that would impact the performance.

@gselzer
Copy link
Collaborator Author

gselzer commented Nov 13, 2024

One suggestion: write "Conda environment" rather than "Mamba environment", since the technology in question is Conda here; mamba is just the CLI tool that works with them.

While I agree "Conda environment" is more general, we try hard to use Mamba everywhere in the document, so I'd think leaving it as is would be best? I think it would also introduce a disconnect within the admonition itself, as we'd say it's a conda environment but then we're not mentioning conda in the environment setup line...

@gselzer gselzer marked this pull request as ready for review November 13, 2024 19:47
@gselzer gselzer merged commit 9718380 into main Nov 13, 2024
8 checks passed
@gselzer gselzer deleted the use-cases-0.2 branch November 13, 2024 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update all documentation images before 0.2.0 release Describe python component versions in the use cases
2 participants