Skip to content

Improve CLI doc and error message #417

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Oct 2, 2025
Merged

Improve CLI doc and error message #417

merged 2 commits into from
Oct 2, 2025
+22 −6

Conversation

Firobe
Copy link
Collaborator

@Firobe Firobe commented Oct 1, 2025

Tries to improve the man page and error message to help with #416

  • when a list is expected, this is now explicitly said, and the full syntax for list is provided
  • all CLI flags that expect such a list now give useful example values in the man page

reynir
reynir approved these changes Oct 2, 2025
View reviewed changes
Copy link
Contributor

@reynir reynir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@Firobe Firobe merged commit 52ca551 into main Oct 2, 2025
0 of 3 checks passed
@Firobe Firobe deleted the improve-cli-doc branch October 2, 2025 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@reynir reynir reynir approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Firobe @reynir