Normalise config descriptions and add default values to most of them #2221
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
johnnovak
force-pushed
the
jn/normalise-config-descriptions
branch
from
36a7f75
to
a866643
Compare
kcgen
reviewed
Jan 13, 2023
kcgen
reviewed
Jan 13, 2023
kcgen
reviewed
Jan 13, 2023
kcgen
reviewed
Jan 13, 2023
johnnovak
force-pushed
the
jn/normalise-config-descriptions
branch
from
a866643
to
376a1df
Compare
|
I've wrapped every single config description to 79 chars as you suggested @FeralChild64, plus I've made numerous other improvements. It's about 90% there now, and I could keep doing this for another day, but I'm already feeling dizzy, so I'll stop at this point 😄 |
johnnovak
force-pushed
the
jn/normalise-config-descriptions
branch
3 times, most recently
from
36e5959
to
b3c8ba3
Compare
johnnovak
force-pushed
the
jn/normalise-config-descriptions
branch
from
b3c8ba3
to
bc5639a
Compare
kcgen
approved these changes
Jan 14, 2023
There was a problem hiding this comment.
Conf files are looking very consistent and less ragged - very nice cleanup, @johnnovak!
johnnovak
force-pushed
the
jn/normalise-config-descriptions
branch
from
0f6e91a
to
4db5ead
Compare
Even though KiB and MiB are the proper base-2 units as defined by IEC, they have never caught on, and Microsoft unilaterally used MB and KB to refer to memory in base-2 units during the DOS era.
johnnovak
force-pushed
the
jn/normalise-config-descriptions
branch
from
4db5ead
to
5a60fea
Compare
4 tasks
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.
The big improvement here is listing the default values for most config settings. Some of the more elaborate ones need the
sprintftreatment; I left those for another pass. Anyway, this takes care of the low-hanging fruit, which is about 90% of all config settings.Almost started re-wrapping the descriptions because some lines got longer after adding the defaults, but quickly realised it's pointless because in the end it's gonna be all over the place anyway (because of the varying levels of indentation, depending on the length of the param names).