Split parameters into logical blocks, add some notes #420
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
|
Thanks! |
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.
While putting them all together and next to the relevant ones makes sense at first, the difference between runtime flags and actual parameters requiring a variable is not that clear if you have that default column there.
I split them up into ones that just toggle and ones requiring a variable, adding notes to say as such. Adjusted the default parameters a little bit to hopefully make more sense. It's still not ideal, but better.
Also added a note about how to configure for strict api key use for those that require this. With the limited width(github your layout is a waste of space) it is hard to add another column for caveats, but if specific toggles require another parameter to be set then this should be mentioned somewhere.