On Wednesday, January 23, 2013 1:51:25 PM UTC-6, stevelitt wrote:
>
> Hi all, 
>

Hi Steve.  Good to hear from you again. 

>
> So, if I have existing Python code, can Leo help me make it 
> self-documenting, and if so, where would I find a "quickstart" guide of 
> how to make an existing Python module self-documenting? 
>

You could say that making self-documenting code is what Leo is all about.

I would recommend, as an easy first step, that you use Leo's @auto feature 
to import existing files.  Leo will parse the file into nodes containing 
functions, classes and methods, with methods being children of class 
nodes.  Just this much will show you code in a new way, and will often 
eliminate many kinds of comments that are pure cruft in Leo.

If you are free to alter the source files, I would suggest writing external 
files with @file instead of @auto.  This will give you more features and 
flexibility than @auto provides.

Once you are comfortable with the basics of Leo, you will be in a better 
position to answer your own question :-)

Edward

-- 
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].
Visit this group at http://groups.google.com/group/leo-editor?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to