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

Unhelpful documentation when misspelling CLI commands #17

Open
Jegp opened this issue Nov 4, 2024 · 0 comments
Open

Unhelpful documentation when misspelling CLI commands #17

Jegp opened this issue Nov 4, 2024 · 0 comments

Comments

@Jegp
Copy link
Contributor

Jegp commented Nov 4, 2024

From @aMarcireau:

My only (minor) concern with the current approach is in cases where the user writes something along the lines of:
faery input ... filter ... filter render ... outputs --file video.mp4 (notice the typo "outputs" instead of "output").

Should this happen, the user would get an error along the lines of "render has no 'outputs' parameter" or possibly "render has no '--file' flag" (if render happens to take a positional argument and 'outputs' is assumed to be that argument). This could cause frustration since the error message points in the wrong direction. Whilst this is not ideal, this may not be a major issue in practice and I do not think that this can be addressed without introducing special characters.

Two ways we could consider mitigating this is to (1) match against closely related groups ("did you mean outputs?") and (2) allow regexes in the group names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant