1 |
maillog: 26/11/2004-10:17:34(+0000): Ciaran McCreesh types |
2 |
> On Fri, 26 Nov 2004 11:25:10 +0900 Georgi Georgiev <chutz@×××.net> |
3 |
> wrote: |
4 |
> | maillog: 25/11/2004-19:19:27(+0000): Ed Grimm types |
5 |
> | > On Thu, 25 Nov 2004, Georgi Georgiev wrote: |
6 |
> | > |
7 |
> | > If you really think that in-line docs are ugly, use vim(1), and |
8 |
> | > automagically fold them out of your view (:help foldexpr, although |
9 |
> | > this can be set to happen in the eclass syntax file). I suspect |
10 |
> | > that most of the people who only occasionally work with the |
11 |
> | > eclasses, and those who are just starting to use the eclasses, would |
12 |
> | > find them more useful than ugly. |
13 |
> | |
14 |
> | I have nothing against in-line docs in general. I simply had trouble |
15 |
> | imagining it in the bash case. |
16 |
> | |
17 |
> | What about using perldoc itself? Simply prepend every doc line with a |
18 |
> | '#', then run |
19 |
> | |
20 |
> | awk '/^#/ { sub("#",""); print } |
21 |
> |
22 |
> In bash? How would that work? |
23 |
|
24 |
I imagined |
25 |
|
26 |
#=item blah blah |
27 |
# more POD |
28 |
# and more |
29 |
# and more |
30 |
#=cut |
31 |
|
32 |
> Here's another possibility: |
33 |
> |
34 |
> # {{{ doc |
35 |
> # whatever format we decide upon |
36 |
> # blah blah blah |
37 |
> # }}} |
38 |
> |
39 |
> Doesn't screw up normal comments, really easy to find and process, easy |
40 |
> to turn into folds in the editor :) |
41 |
|
42 |
Sounds great. Now all that's left is to agree upon the format and write |
43 |
the converter. Oh, and my favorite -- a GLEP maybe? (no, I'm not |
44 |
sarcastic; just in a good mood ;) ). |
45 |
|
46 |
-- |
47 |
) Georgi Georgiev ) Hi! I'm Larry. This is my brother Bob, and ) |
48 |
( chutz@×××.net ( this is my other brother Jimbo. We thought ( |
49 |
) +81(90)6266-1163 ) you might like to know the names of your ) |
50 |
( ------------------- ( assailants. ( |