[DOCS] POD Errors

[Michael Scott]

For those of you who like perusing gobs of autogenerated info, take a 
look at

	http://homepage.mac.com/michael_scott/Parrot/pod_report.html

where I've put up a list of Parrot POD errors as seen by podchecker.

I've started to put together a bunch Perl modules which will allow us 
autogenerate HTML documentation from the inline POD. As a step in this 
direction, unless anyone has objections, I'm going to tidy up the POD. 
I'll do this a file at a time, and let you know when it's done.

Mike

Re: [DOCS] POD Errors

[Michael Scott]

So, after migrating from Pod::Checker to Pod-Simple, I've cleared up 
all the pod errors and done a rudimentary html tree. The state of 
parrot pod can be seen here 
http://homepage.mac.com/michael_scott/Parrot/docs/html/. That's every 
file that has pod in it. Obviously there are a few files such as 
imcc/t/syn/pod.t that contain pod that is not documentation. Just 
ignore them.

I'll move on to phase 2 now, which is to normalize existing pod and add 
some minimal content to files that need it.

The idle browser may notice that there are some links in the files, all 
broken. This is because Pod::Simple::HTML needs fixing.

Mike

Re: [DOCS] POD Errors

[chromatic]

On Thu, 2004-01-15 at 15:02, Michael Scott wrote:

> So, after migrating from Pod::Checker to Pod-Simple, I've cleared up 
> all the pod errors and done a rudimentary html tree.

Do you have patches to fix the errors in CVS or are they even necessary?

-- c

Re: [DOCS] POD Errors

[Michael Scott]

They're already commited.

On 16 Jan 2004, at 00:21, chromatic wrote:

On Thu, 2004-01-15 at 15:02, Michael Scott wrote:

So, after migrating from Pod::Checker to Pod-Simple, I've cleared up
all the pod errors and done a rudimentary html tree.
Do you have patches to fix the errors in CVS or are they even 
necessary?

-- c