Enhance Command Line documentation by organizing options in Tabular format about checkstyle HOT 9 OPEN

Google style has links to itself, to specific row.
When you click on anchor image, you got a link and you can share it with others, it will be a link to exact place, not a page in general

from checkstyle.

I like tables, @romani please approve if you are good. I would prefer just “Option” and “Description”

from checkstyle.

Send PR, I will point what to do in PR

from checkstyle.

I think this would be fine, but I this would need to be an issue first to gain approvals from the others. @nrmancuso is already trying to rewrite other parts of our documentation, so I want to sure we align with his current thoughts.

I think @rnveach is on board with the proposal....
@nrmancuso , @romani , thoughts please ?

from checkstyle.

Yes, let's try table view.
Please make first column (or just embed in name of parameter) to be anchor, let us make direct links to specific argument.

Example:
https://checkstyle.org/google_style.html#a2

from checkstyle.

let us make direct links to specific argument.

@romani , I'm not sure what links are being referred to here? Are you asking that each option redirects to another new page containing description? Because we don't host any existing html to these options as far as I know..

Example:
https://checkstyle.org/google_style.html#a2

The links here point to the check html page and google style guide page.
I'm not sure why we need embedded links in cmdline because it is just an option and respective description (2 plain columns)

We could point these links to the repo Main.java file if that's what you meant....
Could you please elaborate on what your vision is? Or if I'm missing something?

from checkstyle.

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

from checkstyle.

Yes @romani , your #14759 (comment) was clear enough for me 😄

consider https://checkstyle.org/property_types.html#Pattern.5B.5D as example,

I get what you want me to do here,
but I don't see anchored links in the example you gave? Do you want that page also updated?

from checkstyle.

@romani , @rnveach , I'm waiting on #14710 to get merged before we do this update....

from checkstyle.