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

aeolus-cli help and man page lacks information #2

Open
martinpovolny opened this issue Oct 4, 2012 · 1 comment
Open

aeolus-cli help and man page lacks information #2

martinpovolny opened this issue Oct 4, 2012 · 1 comment

Comments

@martinpovolny
Copy link

trying to use aeolus-cli I start with 'man aeolus'

I lean about the config file .aeolus-cli

but I get no information about the format of the file, nor example

googling it I get:

http://mo.morsi.org/blog/node/374

trying the given example I get an ugly error:

/usr/share/ruby/psych.rb:203: in 'parse' ()....

the problem is I used TABS instead of SPACES as indentation but how should I know?

the man page and/or the --help should tell me the config file is a YAML file at least

given the average user does not know YAML and that he has to use SPACES and no TABS, it would be better to use either some generally used and known and more relaxed format or at least provide the user with a more understandable error message

@hacxman
Copy link
Member

hacxman commented Nov 13, 2012

What I see now is that we can either

  • possibly make it more robust, by replacing TABS with spaces
  • patch Psych itself so it would raise proper exception (providing user with correct error)

And yes, documentation should be updated as well.
What do you think?

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

2 participants