284352 - Break Bugzilla::DB code/docs into sections

Status: RESOLVED FIXED

(Bugzilla :: Bugzilla-General, enhancement)

Description

[Max Kanat-Alexander]

I'm going to be adding a lot of stuff to the Bugzilla::DB docs, so the sections
need to be clearer.

I have a patch for this, coming up.

Comment 1

[Max Kanat-Alexander]

Attachment: Slight cleanup for Bugzilla::DB docs

Comment 2

[Shane H. W. Travis]

Comment on attachment 175978 [details] [diff] [review]
Slight cleanup for Bugzilla::DB docs

+These methods are actually implemented in Bugzilla::DB, and only need
 -- remove 'actually'

+Thse methods return information about data in the database.
 ^^^^^ typo

+=head2 Schema Info Methods
-- don't abbrev. if you don't have to. (Same thing on the next line)

+These methods deal with starting and stopping transactions in the database.
Grammar: These methods deal with THE starting and stopping OF transactions in
the database.

+These methods deal with starting and stopping transactions in the database.

Missing the "=over 4" after this line.

Fix these for r+.

Comment 3

[Max Kanat-Alexander]

Attachment: Add "sections" to Bugzilla::DB

I slightly expanded the scope of the bug, to also add comments above each
"section" in the code, so we can keep things organized there, too.

Comment 4

[Shane H. W. Travis]

Comment on attachment 176223 [details] [diff] [review]
Add "sections" to Bugzilla::DB

+These methods return info about the current Bugzilla database schema.

Everywhere else, you spell out 'information' in full, as per my last review
except on this one line. This is more than a nit, I suppose, as I'd really like
it to be consistent, but I trust you to fix it yourself on checkin.

r+ by inspection.

Comment 5

[Max Kanat-Alexander]

Ohh, arrgh, I forgot to fix that checkin change, though. Ahh, well. It wasn't
hugely important.

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