diff options
author | Prathamesh Sonpatki <csonpatki@gmail.com> | 2016-09-06 23:10:15 +0530 |
---|---|---|
committer | Prathamesh Sonpatki <csonpatki@gmail.com> | 2016-09-06 23:10:15 +0530 |
commit | c683ac4fe0313e346d10f2522b0db312ec470715 (patch) | |
tree | e99c407a10ee02ed511bce242cffd91aa796eed0 /actioncable | |
parent | 0c91b166e612d8dba0ededec99cfb39b85d31fbb (diff) | |
download | rails-c683ac4fe0313e346d10f2522b0db312ec470715.tar.gz rails-c683ac4fe0313e346d10f2522b0db312ec470715.tar.bz2 rails-c683ac4fe0313e346d10f2522b0db312ec470715.zip |
[ci fix] Fix API documentation for Streams module from Action Cable
Diffstat (limited to 'actioncable')
-rw-r--r-- | actioncable/lib/action_cable/channel/streams.rb | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/actioncable/lib/action_cable/channel/streams.rb b/actioncable/lib/action_cable/channel/streams.rb index 561750d713..13deb62662 100644 --- a/actioncable/lib/action_cable/channel/streams.rb +++ b/actioncable/lib/action_cable/channel/streams.rb @@ -69,8 +69,8 @@ module ActionCable # Start streaming from the named <tt>broadcasting</tt> pubsub queue. Optionally, you can pass a <tt>callback</tt> that'll be used # instead of the default of just transmitting the updates straight to the subscriber. - # Pass `coder: ActiveSupport::JSON` to decode messages as JSON before passing to the callback. - # Defaults to `coder: nil` which does no decoding, passes raw messages. + # Pass <tt>coder: ActiveSupport::JSON</tt> to decode messages as JSON before passing to the callback. + # Defaults to <tt>coder: nil</tt> which does no decoding, passes raw messages. def stream_from(broadcasting, callback = nil, coder: nil, &block) broadcasting = String(broadcasting) @@ -94,8 +94,8 @@ module ActionCable # <tt>callback</tt> that'll be used instead of the default of just transmitting the updates straight # to the subscriber. # - # Pass `coder: ActiveSupport::JSON` to decode messages as JSON before passing to the callback. - # Defaults to `coder: nil` which does no decoding, passes raw messages. + # Pass <tt>coder: ActiveSupport::JSON</tt> to decode messages as JSON before passing to the callback. + # Defaults to <tt>coder: nil</tt> which does no decoding, passes raw messages. def stream_for(model, callback = nil, coder: nil, &block) stream_from(broadcasting_for([ channel_name, model ]), callback || block, coder: coder) end |