Skip to content

Commit 077b2c1

Browse files
authored
Merge pull request rails#48028 from p8/docs/actioncable-headers
Clean up Action Cable documentation headers [ci skip]
2 parents f2327e8 + c4f0c10 commit 077b2c1

File tree

5 files changed

+9
-3
lines changed

5 files changed

+9
-3
lines changed

actioncable/lib/action_cable/channel/callbacks.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
module ActionCable
66
module Channel
7-
# = Action Cable Channel Callbacks
7+
# = Action Cable \Channel \Callbacks
88
#
99
# Action Cable Channel provides hooks during the life cycle of a channel subscription.
1010
# Callbacks allow triggering logic during this cycle. Available callbacks are:

actioncable/lib/action_cable/channel/test_case.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ def initialize(name)
1515
end
1616
end
1717

18+
# = Action Cable \Channel Stub
19+
#
1820
# Stub +stream_from+ to track streams for the channel.
1921
# Add public aliases for +subscription_confirmation_sent?+ and
2022
# +subscription_rejected?+.

actioncable/lib/action_cable/connection/callbacks.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
module ActionCable
66
module Connection
7-
# = Action Cable Connection Callbacks
7+
# = Action Cable \Connection \Callbacks
88
#
99
# There are <tt>before_command</tt>, <tt>after_command</tt>, and <tt>around_command</tt> callbacks
1010
# available to be invoked before, after or around every command received by a client respectively.

actioncable/lib/action_cable/remote_connections.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
require "active_support/core_ext/module/redefine_method"
44

55
module ActionCable
6+
# = Action Cable Remote Connections
7+
#
68
# If you need to disconnect a given connection, you can go through the
79
# RemoteConnections. You can find the connections you're looking for by
810
# searching for the identifier declared on the connection. For example:
@@ -36,6 +38,8 @@ def where(identifier)
3638
end
3739

3840
private
41+
# = Action Cable Remote \Connection
42+
#
3943
# Represents a single remote connection found via <tt>ActionCable.server.remote_connections.where(*)</tt>.
4044
# Exists solely for the purpose of calling #disconnect on that connection.
4145
class RemoteConnection

actioncable/lib/action_cable/subscription_adapter/test.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
module ActionCable
44
module SubscriptionAdapter
5-
# == Test adapter for Action Cable
5+
# == \Test adapter for Action Cable
66
#
77
# The test adapter should be used only in testing. Along with
88
# ActionCable::TestHelper it makes a great tool to test your Rails application.

0 commit comments

Comments
 (0)