lib/slack/endpoint/reminders.rb in slack-api-1.6.0 vs lib/slack/endpoint/reminders.rb in slack-api-1.6.1
- old
+ new
@@ -2,11 +2,11 @@
module Slack
module Endpoint
module Reminders
#
- # This method creates a reminder.
+ # Creates a reminder.
#
# @option options [Object] :text
# The content of the reminder
# @option options [Object] :time
# When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday")
@@ -20,11 +20,11 @@
throw ArgumentError.new("Required arguments :time missing") if options[:time].nil?
post("reminders.add", options)
end
#
- # This method completes a reminder.
+ # Marks a reminder as complete.
#
# @option options [Object] :reminder
# The ID of the reminder to be marked as complete
# @see https://api.slack.com/methods/reminders.complete
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/reminders.complete.md
@@ -33,11 +33,11 @@
throw ArgumentError.new("Required arguments :reminder missing") if options[:reminder].nil?
post("reminders.complete", options)
end
#
- # This method deletes a reminder.
+ # Deletes a reminder.
#
# @option options [Object] :reminder
# The ID of the reminder
# @see https://api.slack.com/methods/reminders.delete
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/reminders.delete.md
@@ -46,11 +46,11 @@
throw ArgumentError.new("Required arguments :reminder missing") if options[:reminder].nil?
post("reminders.delete", options)
end
#
- # This method returns information about a reminder.
+ # Gets information about a reminder.
#
# @option options [Object] :reminder
# The ID of the reminder
# @see https://api.slack.com/methods/reminders.info
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/reminders.info.md
@@ -59,10 +59,10 @@
throw ArgumentError.new("Required arguments :reminder missing") if options[:reminder].nil?
post("reminders.info", options)
end
#
- # This method lists all reminders created by or for a given user.
+ # Lists all reminders created by or for a given user.
#
# @see https://api.slack.com/methods/reminders.list
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/reminders.list.md
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/reminders.list.json
def reminders_list(options={})