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

installation.md: update shell syntax for setting env vars #7138

Merged
merged 1 commit into from
Sep 7, 2024

Conversation

ilyagr
Copy link
Contributor

@ilyagr ilyagr commented Sep 6, 2024

I find this more readable; it also no longer requires bash (thought just replacing bash with sh would achieve that much).

Strictly speaking, env is not necessary on most shells, but I find it makes things clearer.

Test Plan

Ran the command locally, did not try compiling the docs.


Aside, loosely related (and hopefully helpful) suggestions:

I'm hoping you will also explain in the docs how to install to ~/.local/bin, with the same goal as #6839. Using environment variables for that is fine.

Another minor FR I'd have is to mention these environment variables in the help message of the installer script, especially if you want to encourage people to use them.

Thank you for working on the installation script! It helps me feel more comfortable about eventually asking that people install uv to compile docs on my project, hopefully helping people who don't have a Python environment already installed.

I find this more readable; it also no longer requires bash (thought just replacing `bash` with `sh` would achieve that much).

Strictly speaking, `env` is not necessary on most shells, but I find it makes things clearer.
@zanieb
Copy link
Member

zanieb commented Sep 7, 2024

Thanks this seems reasonable to me! I recently put up #7107#6839 which looked a bit too complicated for users and I've been working with the upstream team to make configuration of the installer simpler / clearer.

Another minor FR I'd have is to mention these environment variables in the help message of the installer script, especially if you want to encourage people to use them.

Can you open an issue for this so we can track it?

@zanieb zanieb added the documentation Improvements or additions to documentation label Sep 7, 2024
@zanieb zanieb merged commit 23c0d9b into astral-sh:main Sep 7, 2024
47 checks passed
@zanieb
Copy link
Member

zanieb commented Sep 7, 2024

One small problem with this approach is now the Windows recommendation is a different style :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants