@@ -64,8 +64,8 @@ def resolvable_event
64
64
resolvable_event_on default_executor
65
65
end
66
66
67
- # Created resolvable event, user is responsible for resolving the event once by
68
- # {Promises::ResolvableEvent#resolve}.
67
+ # Creates a resolvable event, user is responsible for resolving the event once
68
+ # by calling {Promises::ResolvableEvent#resolve}.
69
69
#
70
70
# @!macro promises.param.default_executor
71
71
# @return [ResolvableEvent]
@@ -95,7 +95,7 @@ def future(*args, &task)
95
95
future_on ( default_executor , *args , &task )
96
96
end
97
97
98
- # Constructs new Future which will be resolved after block is evaluated on default executor.
98
+ # Constructs a new Future which will be resolved after block is evaluated on default executor.
99
99
# Evaluation begins immediately.
100
100
#
101
101
# @!macro promises.param.default_executor
@@ -107,7 +107,7 @@ def future_on(default_executor, *args, &task)
107
107
ImmediateEventPromise . new ( default_executor ) . future . then ( *args , &task )
108
108
end
109
109
110
- # Creates resolved future with will be either fulfilled with the given value or rejection with
110
+ # Creates a resolved future with will be either fulfilled with the given value or rejected with
111
111
# the given reason.
112
112
#
113
113
# @param [true, false] fulfilled
@@ -119,7 +119,7 @@ def resolved_future(fulfilled, value, reason, default_executor = self.default_ex
119
119
ImmediateFuturePromise . new ( default_executor , fulfilled , value , reason ) . future
120
120
end
121
121
122
- # Creates resolved future with will be fulfilled with the given value.
122
+ # Creates a resolved future which will be fulfilled with the given value.
123
123
#
124
124
# @!macro promises.param.default_executor
125
125
# @param [Object] value
@@ -128,7 +128,7 @@ def fulfilled_future(value, default_executor = self.default_executor)
128
128
resolved_future true , value , nil , default_executor
129
129
end
130
130
131
- # Creates resolved future with will be rejected with the given reason.
131
+ # Creates a resolved future which will be rejected with the given reason.
132
132
#
133
133
# @!macro promises.param.default_executor
134
134
# @param [Object] reason
@@ -191,7 +191,7 @@ def delay(*args, &task)
191
191
delay_on default_executor , *args , &task
192
192
end
193
193
194
- # Creates new event or future which is resolved only after it is touched,
194
+ # Creates a new event or future which is resolved only after it is touched,
195
195
# see {Concurrent::AbstractEventFuture#touch}.
196
196
#
197
197
# @!macro promises.param.default_executor
@@ -215,7 +215,7 @@ def schedule(intended_time, *args, &task)
215
215
schedule_on default_executor , intended_time , *args , &task
216
216
end
217
217
218
- # Creates new event or future which is resolved in intended_time.
218
+ # Creates a new event or future which is resolved in intended_time.
219
219
#
220
220
# @!macro promises.param.default_executor
221
221
# @!macro promises.param.intended_time
@@ -241,8 +241,8 @@ def zip_futures(*futures_and_or_events)
241
241
zip_futures_on default_executor , *futures_and_or_events
242
242
end
243
243
244
- # Creates new future which is resolved after all futures_and_or_events are resolved.
245
- # Its value is array of zipped future values. Its reason is array of reasons for rejection.
244
+ # Creates a new future which is resolved after all futures_and_or_events are resolved.
245
+ # Its value is an array of zipped future values. Its reason is an array of reasons for rejection.
246
246
# If there is an error it rejects.
247
247
# @!macro promises.event-conversion
248
248
# If event is supplied, which does not have value and can be only resolved, it's
@@ -263,7 +263,7 @@ def zip_events(*futures_and_or_events)
263
263
zip_events_on default_executor , *futures_and_or_events
264
264
end
265
265
266
- # Creates new event which is resolved after all futures_and_or_events are resolved.
266
+ # Creates a new event which is resolved after all futures_and_or_events are resolved.
267
267
# (Future is resolved when fulfilled or rejected.)
268
268
#
269
269
# @!macro promises.param.default_executor
@@ -281,8 +281,8 @@ def any_resolved_future(*futures_and_or_events)
281
281
282
282
alias_method :any , :any_resolved_future
283
283
284
- # Creates new future which is resolved after first futures_and_or_events is resolved.
285
- # Its result equals result of the first resolved future.
284
+ # Creates a new future which is resolved after the first futures_and_or_events is resolved.
285
+ # Its result equals the result of the first resolved future.
286
286
# @!macro promises.any-touch
287
287
# If resolved it does not propagate {Concurrent::AbstractEventFuture#touch}, leaving delayed
288
288
# futures un-executed if they are not required any more.
@@ -301,9 +301,9 @@ def any_fulfilled_future(*futures_and_or_events)
301
301
any_fulfilled_future_on default_executor , *futures_and_or_events
302
302
end
303
303
304
- # Creates new future which is resolved after first of futures_and_or_events is fulfilled.
305
- # Its result equals result of the first resolved future or if all futures_and_or_events reject,
306
- # it has reason of the last resolved future.
304
+ # Creates a new future which is resolved after the first futures_and_or_events is fulfilled.
305
+ # Its result equals the result of the first resolved future or if all futures_and_or_events reject,
306
+ # it has reason of the last rejected future.
307
307
# @!macro promises.any-touch
308
308
# @!macro promises.event-conversion
309
309
#
@@ -320,7 +320,7 @@ def any_event(*futures_and_or_events)
320
320
any_event_on default_executor , *futures_and_or_events
321
321
end
322
322
323
- # Creates new event which becomes resolved after first of the futures_and_or_events resolves.
323
+ # Creates a new event which becomes resolved after the first futures_and_or_events resolves.
324
324
# @!macro promises.any-touch
325
325
#
326
326
# @!macro promises.param.default_executor
0 commit comments