Improve documentation for configuration #651
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
Although the configuration file was mostly wrapped to a line-width of 80, some lines were wrapped slightly shorter. I fixed this. In general, all sentences were changed to start with a capital letter and end with a period or other punctuation mark. Many of the documentation commets read as, "config option to do XYZ". I shortened these to simply "do XYZ".
nsvedberg
temporarily deployed
to
github-pages
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Although the configuration file was mostly wrapped to a line-width of 80, some lines were wrapped slightly shorter. I fixed this.
In general, all sentences were changed to start with a capital letter and end with a period or other punctuation mark.
Many of the documentation commets read as, "config option to do XYZ". I shortened these to simply "do XYZ".