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: Improve wording of env vars section #1514

Merged
merged 3 commits into from
Mar 26, 2023

Conversation

hyperupcall
Copy link
Contributor

@hyperupcall hyperupcall commented Mar 24, 2023

Improves wording of environmental variables section in two ways:

  1. No longer refer to ~/.asdf as an absolute path

Beginners may take this too literally and do something like export ASDF_DATA_DIR=~/.asdf, which won't work since tilda expansion doesn't occur here (since the ~/ isn't the first two characters in the word, the AS in ASDF_DATA_DIR is).

To prevent misconceptions or potential issues, this has been removed.

  1. Update description of ASDF_DIR

This variable no longer defaults to ~/.asdf, but instead is dynamically set and always refers to the true location of the source files.

@hyperupcall hyperupcall requested a review from a team as a code owner March 24, 2023 10:10
@jthegedus
Copy link
Contributor

@hyperupcall I proposed a larger rewrite of the whole section. I used some of your wording throughout and removed the tilde usage. Have a look and let me know what you think.

@hyperupcall
Copy link
Contributor Author

hyperupcall commented Mar 24, 2023

That's a nice improvement! Once I finally finish up #1351, the extra space will make it easier to write and read the new behavior.

I did change the wording of ASDF_DATA_DIR to be more accurate - since $HOME is always set, ASDF_DATA_DIR will default to $HOME/.asdf. Which is good because otherwise asdf would require superuser priviledges if installed through the AUR.

@jthegedus jthegedus merged commit ec3eb2d into asdf-vm:master Mar 26, 2023
@hyperupcall hyperupcall deleted the docs-envvars branch March 26, 2023 08:13
botp pushed a commit to botp/asdf that referenced this pull request Mar 31, 2023
Co-authored-by: James Hegedus <jthegedus@hey.com>
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