search

qrush / sub

a delicious way to organize programs
http://37signals.com/svn/posts/3264-automating-with-convention-introducing-sub
MIT License
1.74k stars 148 forks source link

Include summary in help output for individual commands if we have it #48

Closed markstos closed 3 years ago

markstos commented 3 years ago

Sometimes the "summary" is all the help that is required for a command and adding more in "Help" would redundant. Also, sometimes "summary" serves as a useful introduction to a longer "Help" document.

So when people ask for the detailed "help" for a command, include the "Summary" as well as the full help.

It's the same value as including a title when someone asks for a document.

qrush commented 3 years ago

Nice! Merging this one in. Thanks!