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

Explain variable modification for configuration #29

Merged
merged 3 commits into from
Sep 30, 2020

Conversation

Epse
Copy link
Contributor

@Epse Epse commented Sep 30, 2020

Add a line to the documentation to clarify where one can add new items to the prompt manually.

Description

From the documentation it wasn't immediately clear to me where to find the configuration of the prompt and how to add new items. This PR adds a single line above the list of items to clarify where these can be added.

How Has This Been Tested

Documentation patch, no tests.

Checklist

  • I have updated the documentation accordingly.

Add a line to the documentation to clarify where one can add new items to the prompt manually.
@Epse Epse requested a review from IlanCosman as a code owner September 30, 2020 09:54
@IlanCosman
Copy link
Owner

IlanCosman commented Sep 30, 2020

Hi Epse, thanks for contributing 😄

From the docs:

Universal variables are stored in the file .config/fish/fish_variables. Do not edit this file directly, as your edits may be overwritten. Edit the variables through fish scripts or by using fish interactively instead.

Instead of editing the fish_variables file, use set --universal from the commandline, or set --global on startup from your config.fish.

You are right that the documentation should do a better job of explaining how to modify the prompt. Can you modify your contribution to explain the methods I mentioned above?

@Epse
Copy link
Contributor Author

Epse commented Sep 30, 2020

Certainly, I just added a commit to do that!

@Epse
Copy link
Contributor Author

Epse commented Sep 30, 2020

For the record, I have no clue what the prettier CI is complaining about. Prettier on my machine is perfectly happy.

@Epse
Copy link
Contributor Author

Epse commented Sep 30, 2020

Alright managed to fix it

@IlanCosman IlanCosman changed the title Clarify location of prompt items Explain variable modification for configuration Sep 30, 2020
@IlanCosman IlanCosman merged commit 37390be into IlanCosman:main Sep 30, 2020
@IlanCosman
Copy link
Owner

Thanks for contributing @Epse 😄

@Epse Epse deleted the patch-1 branch September 30, 2020 15:51
@Epse
Copy link
Contributor Author

Epse commented Sep 30, 2020

You're welcome!

IlanCosman added a commit that referenced this pull request Oct 1, 2020
* Clarify location of prompt items

Add a line to the documentation to clarify where one can add new items to the prompt manually.

* Clarify how to properly set config variables

As per @IlanCosman's request

* Minor edits

Co-authored-by: Ilan Cosman <[email protected]>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants