Skip to content

Reformat option documentation tables #2674

Description

@rgoldberg

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:

  1. Option: as current
  2. Description: as current, but remove all values
  3. Default: Default value. Don't re-list default in "Other Values".
  4. Other Values:
    1. Separate with / or some other single character. Don't use , or.
    2. Enclose literals in double quotes.
    3. Value type descriptions not enclosed in double quotes. Should specify exact valid value ranges more precisely than current documentation.
    4. Descriptions of what literals or value type descriptions mean should follow value & be in parentheses.
    5. 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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions