New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhance Command Line documentation by organizing options in Tabular format #14759
Comments
I think @rnveach is on board with the proposal.... |
I like tables, @romani please approve if you are good. I would prefer just “Option” and “Description” |
Yes, let's try table view. |
This comment was marked as resolved.
This comment was marked as resolved.
Google style has links to itself, to specific row. |
consider https://checkstyle.org/property_types.html#Pattern.5B.5D as example, move mouse over title, anchor appears and by click you can get a link exactly to this item in huge whole page |
Yes @romani , your #14759 (comment) was clear enough for me 😄
I get what you want me to do here, |
Send PR, I will point what to do in PR |
Extension of PR #14710 and response to #14710 (comment)
Current cmdline docs : https://checkstyle.org/cmdline.html#Command_line_usage
Our command line options are bulleted under one section at present.
A better way of documenting for end users would be organizing all the available cmdline options in a Tabular format.
The table would consist of 2 columns (Titles can be "
Command Line Option
" and "Description
" or decided further)and 18 rows for each of the 18 options that we host.
This format of documentation is the standard and can be found followed by Apache maven CLI options too
https://maven.apache.org/ref/3.6.1/maven-embedder/cli.html#
The text was updated successfully, but these errors were encountered: