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

quote the builtin install instructions #122

Merged
merged 1 commit into from
Oct 29, 2023
Merged

quote the builtin install instructions #122

merged 1 commit into from
Oct 29, 2023

Conversation

pmeier
Copy link
Member

@pmeier pmeier commented Oct 27, 2023

@dharhas reported offline, that pip install ragna[builtin] doesn't work.

However, pip install ragna[builtin] works. In fact, this is what we use in CI to install our dependencies:

- name: Install ragna
shell: bash -el {0}
run: |
if [[ ${{ inputs.optional-dependencies }} == true ]]
then
PROJECT_PATH='.[builtin]'
else
PROJECT_PATH='.'
fi
pip install --editable "${PROJECT_PATH}"

I don't have the actual error in front of me, but I'd wager a guess that something else than bash was used?

In other shells, e.g. zsh, [...] has special meaning, There you would see

❯ pip install ragna[builtin]
zsh: no matches found: ragna[builtin]

Solution to this is simple: quote the offending part:

❯ pip install 'ragna[builtin]'

So this is a "user error". But I can see that this will be common enough. So let's just quote the installation instruction by default, as it has no negative effect other than "looking awkward".

@pmeier pmeier requested a review from pavithraes October 27, 2023 07:32
@pavithraes pavithraes merged commit 1f822ce into main Oct 29, 2023
3 checks passed
@pavithraes pavithraes deleted the quote-extra branch October 29, 2023 20:11
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.

2 participants