[open-ils-commits] r15997 - trunk/Open-ILS/src/perlmods/OpenILS/Application (erickson)

[svn at svn.open-ils.org]

Author: erickson
Date: 2010-03-25 17:27:05 -0400 (Thu, 25 Mar 2010)
New Revision: 15997

Modified:
   trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
Log:
Cleanup generally sound method reg. docs

Modified: trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
===================================================================
--- trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm	2010-03-25 21:27:04 UTC (rev 15996)
+++ trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm	2010-03-25 21:27:05 UTC (rev 15997)
@@ -265,17 +265,16 @@
 
 
 __PACKAGE__->register_method(
-    api_name => 'open-ils.actor.ou_setting.ancestor_default',
-    method => 'ou_ancestor_setting',
+    api_name  => 'open-ils.actor.ou_setting.ancestor_default',
+    method    => 'ou_ancestor_setting',
     signature => {
-        desc => q/Get an org unit setting value as seen from your org unit.  IF AND ONLY IF
-        you provide an authentication token, this method will make sure that the given
-        user has permission to view that setting, if there is a permission associated
-        with the setting./,
+        desc => 'Get the org unit setting value associated with the setting name as seen from the specified org unit.  ' .
+                'IF AND ONLY IF an authentication token is provided, this method will make sure that the given '         .
+                'user has permission to view that setting, if there is a permission associated with the setting.'        ,
         params => [
-            {desc => 'org unit id', type => 'number'},
-            {desc => 'setting name', type => 'string'},
-            {desc => '(optional) authtoken', type => 'string'},
+            { desc => 'org unit id',          type => 'number' },
+            { desc => 'setting name',         type => 'string' },
+            { desc => 'authtoken (optional)', type => 'string' }
         ],
         return => {desc => 'A value for the org unit setting, or undef'}
     }
@@ -294,17 +293,16 @@
 }
 
 __PACKAGE__->register_method(
-    api_name => 'open-ils.actor.ou_setting.ancestor_default.batch',
-    method => 'ou_ancestor_setting_batch',
+    api_name  => 'open-ils.actor.ou_setting.ancestor_default.batch',
+    method    => 'ou_ancestor_setting_batch',
     signature => {
-        desc => q/Get org unit setting name => value pairs as seen from the specified org unit.
-        IF AND ONLY IF you provide an authentication token, this method will make sure
-        that the given user has permission to view that setting, if there is a
-        permission associated with the setting./,
+        desc => 'Get org unit setting name => value pairs for a list of names, as seen from the specified org unit.  ' .
+                'IF AND ONLY IF an authentication token is provided, this method will make sure that the given '       .
+                'user has permission to view that setting, if there is a permission associated with the setting.'      ,
         params => [
-            {desc => 'org unit id', type => 'number'},
-            {desc => 'setting name list', type => 'array'},
-            {desc => '(optional) authtoken', type => 'string'},
+            { desc => 'org unit id',          type => 'number' },
+            { desc => 'setting name list',    type => 'array'  },
+            { desc => 'authtoken (optional)', type => 'string' }
         ],
         return => {desc => 'A hash with name => value pairs for the org unit settings'}
     }
@@ -318,8 +316,6 @@
 
 
 
-
-
 __PACKAGE__->register_method(
 	method	=> "update_patron",
 	api_name	=> "open-ils.actor.patron.update",);