diff options
author | Eileen M. Uchitelle <eileencodes@gmail.com> | 2016-02-02 15:12:27 -0500 |
---|---|---|
committer | Eileen M. Uchitelle <eileencodes@gmail.com> | 2016-02-02 15:12:27 -0500 |
commit | d34db3d7e695cad08963f3979aa39492b1f433c4 (patch) | |
tree | 5f6eaf8b78d1fcdc0d6b29a949bbfc1d4445b2c2 /actioncable/lib/action_cable/remote_connections.rb | |
parent | 473f63734a55d2a91083a619ce1395dfe32aec8d (diff) | |
parent | 830543738507f49444956b3b6ae897f4638b2523 (diff) | |
download | rails-d34db3d7e695cad08963f3979aa39492b1f433c4.tar.gz rails-d34db3d7e695cad08963f3979aa39492b1f433c4.tar.bz2 rails-d34db3d7e695cad08963f3979aa39492b1f433c4.zip |
Merge pull request #23429 from qrush/actioncable-doc-update
Several ActionCable doc fixes
Diffstat (limited to 'actioncable/lib/action_cable/remote_connections.rb')
-rw-r--r-- | actioncable/lib/action_cable/remote_connections.rb | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/actioncable/lib/action_cable/remote_connections.rb b/actioncable/lib/action_cable/remote_connections.rb index aa2fc95d2f..7ec121308a 100644 --- a/actioncable/lib/action_cable/remote_connections.rb +++ b/actioncable/lib/action_cable/remote_connections.rb @@ -1,6 +1,7 @@ module ActionCable - # If you need to disconnect a given connection, you go through the RemoteConnections. You find the connections you're looking for by - # searching the identifier declared on the connection. Example: + # If you need to disconnect a given connection, you can go through the + # RemoteConnections. You can find the connections you're looking for by + # searching for the identifier declared on the connection. For example: # # module ApplicationCable # class Connection < ActionCable::Connection::Base @@ -11,8 +12,9 @@ module ActionCable # # ActionCable.server.remote_connections.where(current_user: User.find(1)).disconnect # - # That will disconnect all the connections established for User.find(1) across all servers running on all machines (because it uses - # the internal channel that all these servers are subscribed to). + # This will disconnect all the connections established for + # <tt>User.find(1)</tt> across all servers running on all machines, because + # it uses the internal channel that all these servers are subscribed to. class RemoteConnections attr_reader :server @@ -25,7 +27,7 @@ module ActionCable end private - # Represents a single remote connection found via ActionCable.server.remote_connections.where(*). + # Represents a single remote connection found via <tt>ActionCable.server.remote_connections.where(*)</tt>. # Exists for the solely for the purpose of calling #disconnect on that connection. class RemoteConnection class InvalidIdentifiersError < StandardError; end |