Skip to content

Commit 6640b85

Browse files
committed
Fix md label-lists rendering incorrectly
When converting docs from RDoc to Markdown, some label-lists ended up not rendering properly. This appears to be due to RDoc's Markdown parser not recognizing label-list labels if the label has additional markup around it (in this case, bold markers `**`). Additionally, the markdown label-list was missing newlines between list items which also caused the label-list to not render correctly. This commit fixes both of these issues for cases where the RDoc originally used <b> tags in a label-list label. Since label-list labels will already be bolded, there is no reason to also use `**` on the labels.
1 parent f735328 commit 6640b85

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

actioncable/lib/action_cable/channel/test_case.rb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,12 +142,14 @@ def connection_gid(ids)
142142
# ActionCable::Channel::TestCase will also automatically provide the following
143143
# instance methods for use in the tests:
144144
#
145-
# **connection**
145+
# connection
146146
# : An ActionCable::Channel::ConnectionStub, representing the current HTTP
147147
# connection.
148-
# **subscription**
148+
#
149+
# subscription
149150
# : An instance of the current channel, created when you call `subscribe`.
150-
# **transmissions**
151+
#
152+
# transmissions
151153
# : A list of all messages that have been transmitted into the channel.
152154
#
153155
#

actionpack/lib/action_controller/test_case.rb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -288,14 +288,16 @@ def load!
288288
# ActionController::TestCase will also automatically provide the following
289289
# instance variables for use in the tests:
290290
#
291-
# **@controller**
291+
# @controller
292292
# : The controller instance that will be tested.
293-
# **@request**
293+
#
294+
# @request
294295
# : An ActionController::TestRequest, representing the current HTTP request.
295296
# You can modify this object before sending the HTTP request. For example,
296297
# you might want to set some session properties before sending a GET
297298
# request.
298-
# **@response**
299+
#
300+
# @response
299301
# : An ActionDispatch::TestResponse object, representing the response of the
300302
# last HTTP response. In the above example, `@response` becomes valid after
301303
# calling `post`. If the various assert methods are not sufficient, then you

0 commit comments

Comments
 (0)