On Fri, 26 Nov 2004 11:25:10 +0900 Georgi Georgiev <chutz@gg3.net>
wrote:
| maillog: 25/11/2004-19:19:27(+0000): Ed Grimm types
| > On Thu, 25 Nov 2004, Georgi Georgiev wrote:
| > 
| > If you really think that in-line docs are ugly, use vim(1), and
| > automagically fold them out of your view (:help foldexpr, although
| > this can be set to happen in the eclass syntax file).  I suspect
| > that most of the people who only occasionally work with the
| > eclasses, and those who are just starting to use the eclasses, would
| > find them more useful than ugly.
| 
| I have nothing against in-line docs in general. I simply had trouble
| imagining it in the bash case.
| 
| What about using perldoc itself? Simply prepend every doc line with a
| '#', then run
| 
| awk '/^#/ { sub("#",""); print }

In bash? How would that work?

Here's another possibility:

# {{{ doc
# whatever format we decide upon
# blah blah blah
# }}}

Doesn't screw up normal comments, really easy to find and process, easy
to turn into folds in the editor :)

-- 
Ciaran McCreesh : Gentoo Developer (Vim, Fluxbox, Sparc, Mips)
Mail            : ciaranm at gentoo.org
Web             : http://dev.gentoo.org/~ciaranm