Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Comparing changes

Choose two branches to see what's changed or to start a new pull request. If you need to, you can also compare across forks.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also compare across forks.
base: e971ea6dbd
...
compare: 40efd00c4f
Checking mergeability… Don't worry, you can still create the pull request.
  • 1 commit
  • 1 file changed
  • 0 commit comments
  • 1 contributor
Commits on Apr 26, 2012
@jwood jwood Updated the documentation 40efd00
Showing with 8 additions and 8 deletions.
  1. +8 −8 lib/proby/proby_task.rb
View
16 lib/proby/proby_task.rb
@@ -54,11 +54,11 @@ def self.list
end
end
- # Fetch the Proby task with the specified task ID.
+ # Fetch the Proby task with the specified API ID.
#
- # @param [String] api_id The api id of the Proby task you would like to get.
+ # @param [String] api_id The API ID of the Proby task you would like to fetch.
#
- # @return [ProbyTask] Your Proby task, or nil if it could not be found.
+ # @return [ProbyTask] The Proby task, or nil if it could not be found.
#
# @example
# ProbyTask.fetch('my_proby_task_api_id')
@@ -88,14 +88,14 @@ 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 [String] :finish_alarms_enabled <b>Optional</b> true if you would like to receive finish alarms for
+ # @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 [String] :maximum_run_time <b>Optional</b> The maximum amount of time the task is allowed to run before
+ # @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.
- # @option attributes [String] :start_notification_grace_period <b>Optional</b> The number of minutes to wait for a task to
+ # @option attributes [Fixnum] :start_notification_grace_period <b>Optional</b> The number of minutes to wait for a task to
# send its start notification after it should have started before sending an alarm.
- # @option attributes [String] :consecutive_alarmed_tasks_required_to_trigger_alarm <b>Optional</b> The number of consecutive
+ # @option attributes [Fixnum] :consecutive_alarmed_tasks_required_to_trigger_alarm <b>Optional</b> The number of consecutive
# tasks that must fail before an alarm is sent.
#
# @return [ProbyTask] The task that was created.
@@ -119,7 +119,7 @@ def self.create(attributes={})
end
end
- # Saves the task in Proby, updating all attributes to the values stored in object. Only the attributes specified in
+ # Saves the task in Proby, updating all attributes to the values stored in the object. Only the attributes specified in
# the ProbyTask.create documentation can be updated.
#
# @example

No commit comments for this range

Something went wrong with that request. Please try again.