Clarify wording for running conda init #713
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
conda-bot
added
the
cla-signed
jaimergp
reviewed
Aug 24, 2023
There was a problem hiding this comment.
This is awesome, thanks! We should probably add it to the PKG UI too.
Good call! I expanded that text, too |
jaimergp
reviewed
Aug 31, 2023
| preferred shell on startup. This will change the command prompt when | ||
| activated. If your prefer that conda's base environment not be activated | ||
| on startup, run `conda config --set auto_activate_base false`. You can | ||
| undo this by running `conda init --reverse ${SHELL}`. |
There was a problem hiding this comment.
Is ${SHELL} expected to be defined here or is it just a placeholder? I am assuming that it will be rendered in the SH installers but I am not sure about the PKGs. If it's meant to be a placeholder, that's ok too, just wanted to make sure it was not an oversight.
There was a problem hiding this comment.
I expect this to be a literal ${SHELL}, not the rendered version. In the sh installers, I escaped the $ sign so that it doesn't get rendered.
jaimergp
reviewed
Aug 31, 2023
Co-authored-by: jaimergp <jaimergp@users.noreply.github.com>
jaimergp
approved these changes
Sep 4, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
When asking whether to execute
conda init, there is no explanation about what the consequences of the decision are. This can surprise new users to conda when their prompt is changed after restarting their shell.Update the prompt to describe what is being changed and how it can be reversed before making a decision.
Checklist - did you ...
newsdirectory (using the template) for the next release's release notes?