Add doc notes about using quote marks on Mac when installing optional
et al
#1916
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.
docs/sphinx/source/reference
for API changes.docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).remote-data
) and Milestone are assigned to the Pull Request and linked Issue.pvlib defines a few sets of optional dependencies that can be installed with
pip install pvlib[optional]
,pip install pvlib[test]
, etc. On zsh, the default shell on Mac, the brackets syntax is interpreted by the shell instead of being passed through topip
, so they must be escaped or wrapped in quotation marks likepip install "pvlib[optional]"
.In #1167 we decided against documenting this since it's not specific to pvlib, but since it has come up again in the JOSS review (openjournals/joss-reviews#5994 (comment)) I think it's worth a small note in our docs.
This PR edits the
installation
andcontributing
docs pages to mention the correct command for Mac users.