Some option documentation tables don't specify defaults, or specify defaults in different positions in the value list.
It would be nice to standardize value & default documentation so that defaults won't ever be unspecified, and they'll always be in a standardized location.
Please reformat option documentation tables to maybe have something like the following columns:
- Option: as current
- Description: as current, but remove all values
- Default: Default value. Don't re-list default in "Other Values".
- Other Values:
- Separate with
/ or some other single character. Don't use , or.
- Enclose literals in double quotes.
- Value type descriptions not enclosed in double quotes. Should specify exact valid value ranges more precisely than current documentation.
- Descriptions of what literals or value type descriptions mean should follow value & be in parentheses.
- Examples follow
ex., instead of For example, , to save space.
e.g.:
| Option |
Description |
Default |
Other Values |
| --max-width |
Maximum length of a line before wrapping |
“none” |
positive integer |
| Option |
Description |
Default |
Other Values |
| --import-grouping |
Import grouping/sorting settings in descending precedence |
“access-control,alpha” |
,-delimited list of: “alpha”, “access-control”, “length”, “testable-first”, “testable-last” |
| Option |
Description |
Default |
Other Values |
| --generic-types |
Additional generic types |
empty list |
;-delimited list of generic types; if no type parameters listed, 1 is inferred. ex. “LinkedList;StateStore<State, Action>" |
Note: I made some guesses in the revised documentation above because the existing documentation is incomplete, and seems to be inconsistent between various parts of the tool & the web site. I might have guessed wrong.
Some option documentation tables don't specify defaults, or specify defaults in different positions in the value list.
It would be nice to standardize value & default documentation so that defaults won't ever be unspecified, and they'll always be in a standardized location.
Please reformat option documentation tables to maybe have something like the following columns:
/or some other single character. Don't use, or.ex., instead ofFor example,, to save space.e.g.:
,-delimited list of: “alpha”, “access-control”, “length”, “testable-first”, “testable-last”;-delimited list of generic types; if no type parameters listed, 1 is inferred. ex. “LinkedList;StateStore<State, Action>"Note: I made some guesses in the revised documentation above because the existing documentation is incomplete, and seems to be inconsistent between various parts of the tool & the web site. I might have guessed wrong.