DOC: put pip install with extra dependency in quotation #1346
Conversation
|
I suppose this fails on some command line interfaces because it tries to interpret the |
Not sure. On OSX. Remembered seeing quotes in dask (https://docs.dask.org/en/latest/install.html#pip). |
Codecov Report
@@ Coverage Diff @@
## master #1346 +/- ##
==========================================
- Coverage 90.26% 90.26% -0.01%
==========================================
Files 226 226
Lines 32718 32718
==========================================
- Hits 29534 29533 -1
- Misses 3184 3185 +1
Continue to review full report at Codecov.
|
doc/source/install.rst
Outdated
|
|
||
| Or all at once, although this isn't recommended due to the large number of | ||
| dependencies: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| $ pip install satpy[all] | ||
| $ pip install "satpy[complete]" |
There was a problem hiding this comment.
| $ pip install "satpy[complete]" | |
| $ pip install "satpy[all]" |
We don't have 'complete' defined in our setup.py file.
There was a problem hiding this comment.
To give more context to what @mraspaud is saying @raybellwaves: The thing inside the brackets is actually referencing items mentioned in the "extra_requires" parameter of the setup.py file. In our setup.py we call this special "all extra dependencies"-type thing "all". In other projects it sounds like they call it "complete".
There was a problem hiding this comment.
But complete works which is why I'm confused and it gets further than all. Anyway I'll revert back to all and move this to a new issue
There was a problem hiding this comment.
See my comment on your new issue #1350. complete and all aren't features of pip, they are manually coded "extras" that dask and satpy have included for the users convenience. They call theirs complete, we call ours all.
flake8 satpyAUTHORS.mdif not there already