Document how to install the zarr optional dependecy. #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zivy
reviewed
Jun 9, 2023
| @@ -35,13 +35,14 @@ Installation | |||
|
|
|||
| The Python module is distributed on `PyPI - The Python Package Index`_. The package can be installed by running: | |||
|
|
|||
| python -m pip install sitkibex | |||
| python -m pip install sitkibex[zarr] | |||
|
|
|||
There was a problem hiding this comment.
I expect python developers to be familiar with the "extras" bracket operator, but I'm not 100% sure with respect to the package users.
Do you think it is clear to the package users that zarr is optional and that they can install it without zarr support via: python -m pip install sitkibex? Should it be stated explicitly?
There was a problem hiding this comment.
I think all of the package users are familiar with the notation used.
zivy
approved these changes
Jun 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.