350649 - Improve the rendering of POD from Bugzilla::DB

Status: RESOLVED FIXED

(Bugzilla :: Database, enhancement)

Description

[Max Kanat-Alexander]

Bugzilla::DB was one of our first modules to have extensive documentation in the Description/Params/Returns style. As such, it's full of <pre> blocks when it's rendered to HTML.

I'm also the owner of the file, so it's easy for me to fix up the POD.

Comment 1

[Max Kanat-Alexander]

Attachment: v1

Granting myself review as module owner.

You can see that I've followed the recommendations I put forth in bug 350643.

You can see the output here, if you'd like:

http://landfill.bugzilla.org/mkanat/docs/api/Bugzilla/DB.html

Comment 2

[Max Kanat-Alexander]

Requesting approval directly, as module owner.

Comment 3

[Marc Schumann [:Wurblzap]]

I'm not really happy with all the B<> stuff (see bug 350643), but it's an improvement anyway.

Comment 4

[Max Kanat-Alexander]

(In reply to comment #3)
> I'm not really happy with all the B<> stuff (see bug 350643), but it's an
> improvement anyway.

  I'm not either. I wanted to make them =head4, but it just didn't work out nearly as well. (You can also see my response in bug 350643.)

Comment 5

[Max Kanat-Alexander]

Checking in Bugzilla/DB.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/DB.pm,v  <--  DB.pm
new revision: 1.84; previous revision: 1.83
done