-h, –help, help, -?, –?
I came across this post on Hacker News that talks about a topic dear to my heart: help flags in command line programs.
You: Hi! I won! Here’s my ticket! Where do I collect my winnings?
Clerk: Hello. I understand you would like to collect your winnings, but I’m afraid I cannot let you do that unless you ask me in a very specific way.
You: …..
Clerk: Perhaps try something like “May I …, please?”
You: May I have my winnings, please?
Clerk: Hello. I understand you would like to collect your winnings, but I’m afraid I cannot let you do that unless you ask me in a very specific way.
You: May I collect my winnings, please?
Clerk: Congrats on winning! Here you go!
This is why I preach about this so much here and at work. Anyway, add -h
and --help
to your scripts, will ya?