That is pretty cool David. I have never used POD nor would have figured out how
to do what you did so easily. I thought your Prima module was very good and
actually thought that your direction was to do something similar to the iPython
notebooks - which I find really handy because I am not a very well rounded
programmer. I think that the concept of the notebook really assists those of us
that create scripts that end up in production, but are not very well documented
simply because we don't know how to use (never looked up why we should use)
POD. The notebook provides us a way to simply do everything without having to
know further information - making it an easier on ramp to using the
application. I use the R version extensively because I can never remember why I
did something the way I did.
CLIFF SOBCHUK
Core RF Engineering
Phone 613-667-1974 ecn: 8109-71974
mobile 403-819-9233
yahoo: sobchuk
www.ericsson.com <http://www.ericsson.com/>
"The author works for Telefonaktiebolaget L M Ericsson ("Ericsson"), who is
solely responsible for this email and its contents. All inquiries regarding
this email should be addressed to Ericsson. The web site for Ericsson is
www.ericsson.com."
This Communication is Confidential. We only send and receive email on the basis
of the terms set out at www.ericsson.com/email_disclaimer
<http://www.ericsson.com/email_disclaimer>
________________________________
From: David Mertens [mailto:[email protected]]
Sent: Tuesday, December 18, 2012 1:18 PM
To: Timothy Pickering
Cc: Pablo marin-garcia; perldl
Subject: Re: [Perldl] Is there a perl tool like ipython notebook? would be very
useful for scratching (and teaching) pdl scripts
OK, I took the bait! Attached is a source filter called Plod.pm and an example
file that uses it. (You'll need to have Filter::Simple installed to use it.)
It's not the most elegant thing in the world, but it shows how you can do some
fun stuff to intermix pod and code in a way that is fairly legible when run
through a POD renderer. For example, visit http://search.cpan.org/pod2html and
upload test.plod, and give it a read. Then run "perl test.plod" to see what the
program does.
It kinda sucks that you have to end any "=for code" blocks with a "=pod"
directive, but that could be addressed with a more sophisticated source filter.
It's not super awesome rich-text or anything, but it's not too bad and
hopefully it can serve as inspiration for somebody. :-)
David
On Tue, Dec 18, 2012 at 7:09 AM, Timothy Pickering <[email protected]>
wrote:
> The chief reason is that Perl's documentation format, POD, is
actually really good, unlike Python's documentation format, for example. As
such, Perl programmers have bent their expectations and mode of expression into
using the tool at hand (POD) rather than creating the more expressive notebook
style of documenting things.
you can compare POD to python docstring/doctest, but comparing it to
ipython notebooks is completely apples to oranges. notebooks aren't for
documenting python code, but rather to document work done using python. you
want to use something like POD to document the final, production scripts/code,
but something like a notebook is very, very handy for figuring out,
documenting, and sharing the steps taken to get there.
tim
--
+-------------------------------------------------------------------+
| T. E. Pickering, Ph.D. | Southern African Large Telescope |
| SALT Astronomer | SAAO |
| [email protected] (520) 305-9823 <tel:%28520%29%20305-9823> |
Observatory Road |
| [email protected] +27(0)214606284 <tel:%2B27%280%29214606284> | 7925
Observatory, South Africa |
+-------------------------------------------------------------------+
overflow error in /dev/null
_______________________________________________
Perldl mailing list
[email protected]
http://mailman.jach.hawaii.edu/mailman/listinfo/perldl
--
"Debugging is twice as hard as writing the code in the first place.
Therefore, if you write the code as cleverly as possible, you are,
by definition, not smart enough to debug it." -- Brian Kernighan
_______________________________________________
Perldl mailing list
[email protected]
http://mailman.jach.hawaii.edu/mailman/listinfo/perldl
