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

Improve config documentation #414

Merged
merged 4 commits into from
Aug 12, 2022
Merged

Conversation

stevensonmt
Copy link
Contributor

update readme to provide some direction on customization options.

update readme to provide some direction on customization options.
@AnErrupTion
Copy link
Collaborator

I don't really understand this. Why only document bg and fg in that case? It seems a bit useless to me.

@stevensonmt
Copy link
Contributor Author

stevensonmt commented Jul 24, 2022

Your comment is unnecessarily harsh.

The number of issues in the issue tracker about this very question suggested it to me. I was trying to avoid putting too much into the readme but would be happy to write up documentation for other settings. I would say all the other settings in config.ini are self explanatory. The color codes used are not as likely to be intuitive to users. If you prefer, this information could be moved to the comments in config.ini but that might get unwieldy.

As for only documenting fg and bg, are there other color settings available?

@AnErrupTion
Copy link
Collaborator

AnErrupTion commented Aug 12, 2022

Your comment is unnecessarily harsh.

I didn't want to be harsh, I just expressed my confusion.

The number of issues in the issue tracker about this very question suggested it to me.

Could you please point these out?

If you prefer, this information could be moved to the comments in config.ini but that might get unwieldy.

I believe this is the best solution. I personally don't think this will cause much readability problems or such.

As for only documenting fg and bg, are there other color settings available?

No, but what I meant is why you only documented the color settings. Now with your comment I do understand.

@stevensonmt
Copy link
Contributor Author

Your comment is unnecessarily harsh.

I didn't want to be harsh, I just expressed my confusion.

No worries. The word 'useless' seemed harsh.

The number of issues in the issue tracker about this very question suggested it to me.

Could you please point these out?

#346
#260
#238
#207
#146
#80

If you prefer, this information could be moved to the comments in config.ini but that might get unwieldy.

I believe this is the best solution. I personally don't think this will cause much readability problems or such.

Moved info to config.ini as comment

@AnErrupTion AnErrupTion merged commit 253ee00 into fairyglade:master Aug 12, 2022
@stevensonmt stevensonmt deleted the patch-1 branch August 12, 2022 20:14
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.

None yet

2 participants