Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

Re^7: Perl 6 Pod -- reinventing the wheel?

by Leviathan (Scribe)
on Nov 25, 2006 at 13:03 UTC ( #586005=note: print w/replies, xml ) Need Help??


in reply to Re^6: Perl 6 Pod -- reinventing the wheel?
in thread Perl6 Pod -- reinventing the wheel?

I am still waiting for your explanation of the escaping syntax so that comments that include Perl arrays don't accidentally turn into Texinfo directives.
Oh. I don't think I understand what you're talking about. In that Texinfo example I was using in the OP, I figured:
# This is a regular comment. Don't start one of # these with a '#@'. #@ This could be a Pod comment. #@ Make sure they always start with a '#@'.

chromatic isn't talking about this. How do you suggest to escape these so that texinfo parses them correctly?

#@ @node do_something #@ #@ @array has to be defined. #@ #@ You'd use this @emph{awesome} function.. #@ #@ Also note that hash slices like @hash{oops} are needed. #@

Replies are listed 'Best First'.
Re^8: Perl 6 Pod -- reinventing the wheel?
by j3 (Friar) on Nov 25, 2006 at 19:21 UTC

    Heh. Well, that one sailed right over my head when I originally posted. :) Thanks.

    I guess then, one could scratch that initial idea about starting each comment line with '#@' and instead just take a nod from the way existing POD does it and wrap the texi docs in =pod/=cut blocks.

    (Edit: Yes, this wouldn't fix that problem either, though, at least it would look just like plain unadorned Texinfo, so the user would do the usual escaping they do when writing an '@' sign -- which could be pretty frequent if documenting a Perl program. Oh well.)

    Anyhow, the whole thing is moot, regardless. It seems that some very smart and experienced people have already volunteered and are interested in putting in the work. Evidently, there's justification for extending Perl 5 POD rather than leaping to some other already-established doc format, and it's accepted that new Perl 6 users will just have to get used to it in addition to whatever other doc formats they currently use for their other documentation needs. Maybe Perl 6 Pod is meant to be general enough to service those general documentation needs as well. Not sure yet.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://586005]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others lurking in the Monastery: (2)
As of 2021-01-20 03:56 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    Notices?