Permalink
Browse files

More doc updates

  • Loading branch information...
1 parent 40efd00 commit e92af87fe97e068b032a17d2552b34eb165b2288 @jwood jwood committed Apr 26, 2012
Showing with 6 additions and 2 deletions.
  1. +4 −0 lib/proby.rb
  2. +2 −2 lib/proby/proby_task.rb
View
@@ -48,6 +48,8 @@ def logger
#
# @param [String] proby_task_id The id of the task to be notified. If nil, the
# value of the +PROBY_TASK_ID+ environment variable will be used.
+ #
+ # @return [Fixnum] The HTTP status code that was returned from Proby.
def send_start_notification(proby_task_id=nil)
Notifier.send_notification('start', proby_task_id)
end
@@ -62,6 +64,8 @@ def send_start_notification(proby_task_id=nil)
# the alarms configured for the given task. Defaults to false.
# @option options [String] :error_message A string message describing the failure that occurred.
# 1,000 character limit.
+ #
+ # @return [Fixnum] The HTTP status code that was returned from Proby.
def send_finish_notification(proby_task_id=nil, options={})
Notifier.send_notification('finish', proby_task_id, options)
end
View
@@ -88,8 +88,8 @@ def self.fetch(api_id)
# @option attributes [String] :time_zone <b>Optional</b> The time zone of the machine executing the task.
# @option attributes [String] :machine <b>Optional</b> The name of the machine that is responsible for running this task.
# Will default to the default time zone configured in Proby if not specified.
- # @option attributes [TrueClass|FalseClass] :finish_alarms_enabled <b>Optional</b> true if you would like to receive finish alarms for
- # this task, false otherwise (default: true).
+ # @option attributes [Boolean] :finish_alarms_enabled <b>Optional</b> true if you would like to receive finish alarms for
+ # this task, false otherwise (default: true).
# @option attributes [Fixnum] :maximum_run_time <b>Optional</b> The maximum amount of time the task is allowed to run before
# Proby sends a finish alarm. If not specified, Proby will determine when an alarm should be
# sent based on past run times.

0 comments on commit e92af87

Please sign in to comment.