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

Explain longoptions in the documentation #8662

Open
Esteban82 opened this issue Jan 3, 2025 · 2 comments
Open

Explain longoptions in the documentation #8662

Esteban82 opened this issue Jan 3, 2025 · 2 comments
Labels
documentation Improve documentation question Further information is requested

Comments

@Esteban82
Copy link
Member

We have to update the documentation to include the long options (which are already available in the code).

I think we should do it before the release of GMT6.6 (#8653).

I am not sure how we should include them in the documentation. No doubt we should add a section in 3.General Features.

But for example, I don't know what should be done for the pages of each module. Whether to add a table with the conversion. Or write another page using only the long options (similar to what was done with the classic vs. modern syntax). What do you think?

I think we should discuss and agree on how we should update the documentation.

@Esteban82 Esteban82 added question Further information is requested documentation Improve documentation labels Jan 3, 2025
@seisman
Copy link
Member

seisman commented Jan 4, 2025

I think few people will use long options if we can't provide a way for autocompletion.

@joa-quim
Copy link
Member

joa-quim commented Jan 4, 2025

I'm afraid I'll have to agree. But how could we do that? Have no idea on how to do it in Windows Cmd. Only thing that comes to mind is some kind of VSC plugin, but requiring users to use VSC to write one-liners is a no-no.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants