LP#1729610: Fix incorrect param description
authorRemington Steed <rjs7@calvin.edu>
Wed, 31 Jan 2018 21:05:52 +0000 (16:05 -0500)
committerMike Rylander <mrylander@gmail.com>
Fri, 4 Jan 2019 19:06:37 +0000 (14:06 -0500)
Mike confirmed that the code expects "pause" to be an integer. This
commit changes the description to reflect that, and to mention the
default value.

Signed-off-by: Remington Steed <rjs7@calvin.edu>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Signed-off-by: Mike Rylander <mrylander@gmail.com>
src/perl/lib/OpenSRF/Application/Slooooooow.pm

index bf218ce..7942f1e 100644 (file)
@@ -34,7 +34,7 @@ __PACKAGE__->register_method(
     argc            => 1,
     signature       => {
         params => [
-            {name => "pause", type => "number", desc => "Seconds to sleep, can be fractional"},
+            {name => "pause", type => "int", desc => "Seconds to sleep (integer, default is 1)"},
             {name => "extra", type => "string", desc => "Extra optional parameter used to inflate the payload size"}
         ],
         return => {