Skip to content
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

Open
MANISH-K-07 opened this issue Apr 3, 2024 · 9 comments · May be fixed by #14799
Open

Enhance Command Line documentation by organizing options in Tabular format #14759

MANISH-K-07 opened this issue Apr 3, 2024 · 9 comments · May be fixed by #14799
Labels

Comments

@MANISH-K-07
Copy link
Contributor

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#

@MANISH-K-07
Copy link
Contributor Author

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 ?

@nrmancuso
Copy link
Member

nrmancuso commented Apr 3, 2024

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

@romani romani added the approved label Apr 5, 2024
@romani
Copy link
Member

romani commented Apr 5, 2024

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

@MANISH-K-07

This comment was marked as resolved.

@romani
Copy link
Member

romani commented Apr 5, 2024

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

@romani
Copy link
Member

romani commented Apr 5, 2024

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

@MANISH-K-07
Copy link
Contributor Author

MANISH-K-07 commented Apr 5, 2024

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?

@romani
Copy link
Member

romani commented Apr 5, 2024

Send PR, I will point what to do in PR

@MANISH-K-07

This comment was marked as outdated.

MANISH-K-07 added a commit to MANISH-K-07/checkstyle that referenced this issue Apr 16, 2024
MANISH-K-07 added a commit to MANISH-K-07/checkstyle that referenced this issue Apr 16, 2024
MANISH-K-07 added a commit to MANISH-K-07/checkstyle that referenced this issue Apr 16, 2024
MANISH-K-07 added a commit to MANISH-K-07/checkstyle that referenced this issue Apr 16, 2024
MANISH-K-07 added a commit to MANISH-K-07/checkstyle that referenced this issue Apr 16, 2024
MANISH-K-07 added a commit to MANISH-K-07/checkstyle that referenced this issue Apr 18, 2024
romani pushed a commit to MANISH-K-07/checkstyle that referenced this issue May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants