Skip to content

Commit 3997ed6

Browse files
Format options doc as a description list [ci-skip]
Prior to this commit, this documentation was formatted as a code block due to indentation.
1 parent 991beab commit 3997ed6

File tree

1 file changed

+9
-6
lines changed
  • actionpack/lib/action_controller/metal

1 file changed

+9
-6
lines changed

actionpack/lib/action_controller/metal/live.rb

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,15 @@ def make_response!(request)
7777
# Writing an object will convert it into standard SSE format with whatever
7878
# options you have configured. You may choose to set the following options:
7979
#
80-
# 1) Event. If specified, an event with this name will be dispatched on
81-
# the browser.
82-
# 2) Retry. The reconnection time in milliseconds used when attempting
83-
# to send the event.
84-
# 3) Id. If the connection dies while sending an SSE to the browser, then
85-
# the server will receive a +Last-Event-ID+ header with value equal to +id+.
80+
# `:event`
81+
# : If specified, an event with this name will be dispatched on the browser.
82+
#
83+
# `:retry`
84+
# : The reconnection time in milliseconds used when attempting to send the event.
85+
#
86+
# `:id`
87+
# : If the connection dies while sending an SSE to the browser, then the
88+
# server will receive a `Last-Event-ID` header with value equal to `id`.
8689
#
8790
# After setting an option in the constructor of the SSE object, all future SSEs
8891
# sent across the stream will use those options unless overridden.

0 commit comments

Comments
 (0)