What
educated_foo is trying to explain is that the tight association between
docstrings and functions facilitates writing/understanding code with such functions.
And it's not limited to the emacs editor as you're trying to imply.
I recently heard a long rant about how inferior the perldebugger is in comparison to a certain Python REPL, where imported methods are not only tab-expanded but also dynamically explained by help of the docstring.
That's only possible because the documentation is part of the introspection.
And nobody said that the higher level documentation shouldn't be done somewhere a big POD block or that deeper information to certain functions couldn't be located there.
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
| |
For: |
|
Use: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.