> Docstrings, and F1 (help-for-command), may be the middle ground that
> resolves the tension between Kent's desire for documentation and my
> belief that nobody reads them.
>
> As a minimal standard, the docstring for a command should mention all
> settings that pertain to that command.  We would like people to get in
> the habit of doing F1 if a command doesn't work as expected, or just
> to explore what Leo can do.

yes please and thank you!

You are right nobody, of which I am one, reads documentation -- at
first. We do, or at least I do -- when I run into trouble and my
intuition about what will happen when I do X turns out to be at odds
with what really happens. So docs are old-style life savers, the big O
one reaches for after finding out the feet don't reach the bottom and
swimming turns out to be harder than expected. ;-)

-- 
-matt

-- 
You received this message because you are subscribed to the Google Groups 
"leo-editor" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/leo-editor?hl=en.

Reply via email to