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

Revise GTP configuration documentation #714

Closed
wants to merge 1 commit into from
Closed

Revise GTP configuration documentation #714

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Dec 14, 2022

Changes:

  • Fit to 80 columns
  • List default options
  • Correct spelling, grammar, typos
  • Apply consistent heading styles
  • Use active voice
  • Move descriptions of options directly above option itself
  • Improve readability (IMO)

@lightvector
Copy link
Owner

I want to read over this more carefully, but at a skim overall looks great, thanks!

@lightvector
Copy link
Owner

Merged as d98d845
Along with a followup b5f2fd6
Thank you!

@lightvector lightvector closed this Jan 7, 2023
@ghost
Copy link
Author

ghost commented Jan 7, 2023

The reason to keep the default value in the text (although redundant) is so that when the user changes the value and mucks something up, they can easily see what the original value used to be (without having to back up the file). It's a feature. :-)

@ghost ghost deleted the 1_update_configuration_file_documentation branch January 10, 2023 04:01
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.

1 participant