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

Improve synopsis in online manual pages #617

Open
rsenden opened this issue Sep 27, 2024 · 0 comments
Open

Improve synopsis in online manual pages #617

rsenden opened this issue Sep 27, 2024 · 0 comments
Labels
effort:? enhancement New feature or request fcli-docs prio:medium Medium priority

Comments

@rsenden
Copy link
Contributor

rsenden commented Sep 27, 2024

Enhancement Request

For fcli help output, synopsis output was improved in 78b530c (showing positional parameters before options), but manual pages still show the old format. If possible, synopsis format in manual pages should match synopsis format from fcli help output:

Manual page:
image

Help output:
image

Notice how <action> is shown before the options list (which is more logical from a user perspective), rather than after the options list.

@rsenden rsenden added enhancement New feature or request prio:medium Medium priority effort:? fcli-docs labels Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort:? enhancement New feature or request fcli-docs prio:medium Medium priority
Projects
None yet
Development

No branches or pull requests

1 participant