From: ivan <ivan>
Date: Thu, 4 Oct 2007 00:51:34 +0000 (+0000)
Subject: POD documentation updates
X-Git-Tag: TRIXBOX_2_6~322
X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=30c6aaeb71369db892cd95451d3f49480c3af7cc

POD documentation updates
---

diff --git a/FS/FS/access_right.pm b/FS/FS/access_right.pm
index 67200f245..cf9730d7e 100644
--- a/FS/FS/access_right.pm
+++ b/FS/FS/access_right.pm
@@ -27,8 +27,8 @@ FS::access_right - Object methods for access_right records
 
 =head1 DESCRIPTION
 
-An FS::access_right object represents an example.  FS::access_right inherits from
-FS::Record.  The following fields are currently supported:
+An FS::access_right object represents a granted access right.  FS::access_right
+inherits from FS::Record.  The following fields are currently supported:
 
 =over 4
 
@@ -49,7 +49,7 @@ FS::Record.  The following fields are currently supported:
 
 =item new HASHREF
 
-Creates a new example.  To add the example to the database, see L<"insert">.
+Creates a new right.  To add the right to the database, see L<"insert">.
 
 Note that this stores the hash reference, not a distinct copy of the hash it
 points to.  You can ask the object for a copy with the I<hash> method.
@@ -88,7 +88,7 @@ returns the error, otherwise returns false.
 
 =item check
 
-Checks all fields to make sure this is a valid example.  If there is
+Checks all fields to make sure this is a valid right.  If there is
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
 
diff --git a/FS/FS/access_user_pref.pm b/FS/FS/access_user_pref.pm
index 31cd4b362..a445d3115 100644
--- a/FS/FS/access_user_pref.pm
+++ b/FS/FS/access_user_pref.pm
@@ -52,7 +52,7 @@ currently supported:
 
 =item new HASHREF
 
-Creates a new preference.  To add the example to the database, see L<"insert">.
+Creates a new preference.  To add the preference to the database, see L<"insert">.
 
 Note that this stores the hash reference, not a distinct copy of the hash it
 points to.  You can ask the object for a copy with the I<hash> method.
diff --git a/FS/FS/access_usergroup.pm b/FS/FS/access_usergroup.pm
index 4d8836c15..8e83060fc 100644
--- a/FS/FS/access_usergroup.pm
+++ b/FS/FS/access_usergroup.pm
@@ -29,8 +29,9 @@ FS::access_usergroup - Object methods for access_usergroup records
 
 =head1 DESCRIPTION
 
-An FS::access_usergroup object represents an example.  FS::access_usergroup inherits from
-FS::Record.  The following fields are currently supported:
+An FS::access_usergroup object represents an internal access user's membership
+in a group.  FS::access_usergroup inherits from FS::Record.  The following
+fields are currently supported:
 
 =over 4
 
@@ -49,7 +50,7 @@ FS::Record.  The following fields are currently supported:
 
 =item new HASHREF
 
-Creates a new example.  To add the example to the database, see L<"insert">.
+Creates a new record.  To add the record to the database, see L<"insert">.
 
 Note that this stores the hash reference, not a distinct copy of the hash it
 points to.  You can ask the object for a copy with the I<hash> method.
@@ -88,7 +89,7 @@ returns the error, otherwise returns false.
 
 =item check
 
-Checks all fields to make sure this is a valid example.  If there is
+Checks all fields to make sure this is a valid record.  If there is
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
 
diff --git a/FS/FS/pay_batch.pm b/FS/FS/pay_batch.pm
index 8ae46ef70..5448b031e 100644
--- a/FS/FS/pay_batch.pm
+++ b/FS/FS/pay_batch.pm
@@ -30,8 +30,8 @@ FS::pay_batch - Object methods for pay_batch records
 
 =head1 DESCRIPTION
 
-An FS::pay_batch object represents an example.  FS::pay_batch inherits from
-FS::Record.  The following fields are currently supported:
+An FS::pay_batch object represents an payment batch.  FS::pay_batch inherits
+from FS::Record.  The following fields are currently supported:
 
 =over 4
 
@@ -54,7 +54,7 @@ FS::Record.  The following fields are currently supported:
 
 =item new HASHREF
 
-Creates a new example.  To add the example to the database, see L<"insert">.
+Creates a new batch.  To add the batch to the database, see L<"insert">.
 
 Note that this stores the hash reference, not a distinct copy of the hash it
 points to.  You can ask the object for a copy with the I<hash> method.
@@ -93,7 +93,7 @@ returns the error, otherwise returns false.
 
 =item check
 
-Checks all fields to make sure this is a valid example.  If there is
+Checks all fields to make sure this is a valid batch.  If there is
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.