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

docs: add quotation to pip install #3051

Conversation

younesStrittmatter
Copy link
Collaborator

pip install example[example] doesn't work in all shells but pip install "example[example]" works consistently.

Copy link

github-actions bot commented Oct 2, 2024

This PR causes the following changes to the html docs (ubuntu-latest-3.11):

diff -r docs-base/_sources/index.rst.txt docs-head/_sources/index.rst.txt
214c214
<     pip install psyneulink[tutorial]
---
>     pip install "psyneulink[tutorial]"
220c220
<     pip install .[tutorial]
---
>     pip install ".[tutorial]"
diff -r docs-base/index.html docs-head/index.html
365c365
< <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">psyneulink</span><span class="p">[</span><span class="n">tutorial</span><span class="p">]</span>
---
> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="s2">&quot;psyneulink[tutorial]&quot;</span>
369c369
< <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">.</span><span class="p">[</span><span class="n">tutorial</span><span class="p">]</span>
---
> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="s2">&quot;.[tutorial]&quot;</span>

...

See CI logs for the full diff.

@kmantel kmantel force-pushed the devel-docs-pip-install-tutorial branch from 857781b to 4a66696 Compare October 2, 2024 02:20
Copy link

github-actions bot commented Oct 2, 2024

This PR causes the following changes to the html docs (ubuntu-latest-3.11):

diff -r docs-base/_sources/index.rst.txt docs-head/_sources/index.rst.txt
214c214
<     pip install psyneulink[tutorial]
---
>     pip install "psyneulink[tutorial]"
220c220
<     pip install .[tutorial]
---
>     pip install ".[tutorial]"
diff -r docs-base/index.html docs-head/index.html
365c365
< <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">psyneulink</span><span class="p">[</span><span class="n">tutorial</span><span class="p">]</span>
---
> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="s2">&quot;psyneulink[tutorial]&quot;</span>
369c369
< <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">.</span><span class="p">[</span><span class="n">tutorial</span><span class="p">]</span>
---
> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="s2">&quot;.[tutorial]&quot;</span>

...

See CI logs for the full diff.

@kmantel kmantel merged commit 9677c8d into PrincetonUniversity:devel Oct 3, 2024
36 checks passed
@kmantel
Copy link
Collaborator

kmantel commented Oct 3, 2024

Thanks!

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