[Rt-commit] rt branch, 4.2/default-scrip-stage-in-initialdata, updated. rt-4.2.2-14-g7cf17ae

Alex Vandiver alexmv at bestpractical.com
Tue Feb 11 14:19:01 EST 2014


The branch, 4.2/default-scrip-stage-in-initialdata has been updated
       via  7cf17ae90896633904a3adc5fcc5d4052e376d6d (commit)
      from  df18958a6c4da89ff107b49ddd48ae63b757d016 (commit)

Summary of changes:
 lib/RT/Scrip.pm | 40 ++++++++++++++++++++++++++++++----------
 1 file changed, 30 insertions(+), 10 deletions(-)

- Log -----------------------------------------------------------------
commit 7cf17ae90896633904a3adc5fcc5d4052e376d6d
Author: Alex Vandiver <alexmv at bestpractical.com>
Date:   Tue Feb 11 14:18:23 2014 -0500

    Reformat paramhash list into =over list in POD

diff --git a/lib/RT/Scrip.pm b/lib/RT/Scrip.pm
index 259a9c6..3e065e6 100644
--- a/lib/RT/Scrip.pm
+++ b/lib/RT/Scrip.pm
@@ -264,18 +264,31 @@ Adds (applies) the current scrip to the provided queue (ObjectId).
 
 Accepts a param hash of:
 
-ObjectId  => Queue name or id. 0 makes the scrip global.
+=over
 
-Stage     => Stage to run in. Valid stages are TransactionCreate or
-TransactionBatch. Defaults to TransactionCreate. As of RT 4.2, Disabled is no
-longer a stage.
+=item C<ObjectId>
 
-Template  => Name of global or queue-specific template for the scrip. Use
-'Blank' for non-notification scrips.
+Queue name or id. 0 makes the scrip global.
 
-SortOrder => Number indicating the relative order the scrip should run in.
+=item C<Stage>
 
-Returns (val, message). If val is false, the message contains an error message.
+Stage to run in. Valid stages are TransactionCreate or
+TransactionBatch. Defaults to TransactionCreate. As of RT 4.2, Disabled
+is no longer a stage.
+
+=item C<Template>
+
+Name of global or queue-specific template for the scrip. Use 'Blank' for
+non-notification scrips.
+
+=item C<SortOrder>
+
+Number indicating the relative order the scrip should run in.
+
+=back
+
+Returns (val, message). If val is false, the message contains an error
+message.
 
 =cut
 
@@ -324,9 +337,16 @@ Removes the current scrip to the provided queue (ObjectId).
 
 Accepts a param hash of:
 
-ObjectId  => Queue name or id. 0 makes the scrip global.
+=over
+
+=item C<ObjectId>
+
+Queue name or id. 0 makes the scrip global.
+
+=back
 
-Returns (val, message). If val is false, the message contains an error message.
+Returns (val, message). If val is false, the message contains an error
+message.
 
 =cut
 

-----------------------------------------------------------------------


More information about the rt-commit mailing list