Skip to content

Commit c396f20

Browse files
authored
Merge pull request rails#48029 from p8/docs/actionpack-headers
Cleanup Action Pack documentation headers [ci-skip]
2 parents 077b2c1 + 48b2059 commit c396f20

File tree

9 files changed

+15
-7
lines changed

9 files changed

+15
-7
lines changed

actionpack/lib/abstract_controller/url_for.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# frozen_string_literal: true
22

33
module AbstractController
4+
# = URL For
5+
#
46
# Includes +url_for+ into the host class (e.g. an abstract controller or mailer). The class
57
# has to provide a +RouteSet+ by implementing the <tt>_routes</tt> methods. Otherwise, an
68
# exception will be raised.

actionpack/lib/action_controller/api.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
require "action_controller/log_subscriber"
66

77
module ActionController
8-
# = Action \Controller \Base
8+
# = Action Controller \API
99
#
1010
# API Controller is a lightweight version of ActionController::Base,
1111
# created for applications that don't require all functionalities that a complete

actionpack/lib/action_controller/metal/data_streaming.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
require "action_dispatch/http/content_disposition"
55

66
module ActionController # :nodoc:
7-
# = Action Controller Data Streaming
7+
# = Action Controller Data \Streaming
88
#
99
# Methods for sending arbitrary data and for streaming files to the browser,
1010
# instead of rendering.

actionpack/lib/action_controller/metal/etag_with_flash.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# frozen_string_literal: true
22

33
module ActionController
4-
# = Action Controller Etag With Flash
4+
# = Action Controller Etag With \Flash
55
#
66
# When you're using the flash, it's generally used as a conditional on the view.
77
# This means the content of the view depends on the flash. Which in turn means

actionpack/lib/action_controller/metal/etag_with_template_digest.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# frozen_string_literal: true
22

33
module ActionController
4-
# = Action Controller Etag With Template Digest
4+
# = Action Controller Etag With Template \Digest
55
#
66
# When our views change, they should bubble up into HTTP cache freshness
77
# and bust browser caches. So the template digest for the current action

actionpack/lib/action_controller/metal/helpers.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# frozen_string_literal: true
22

33
module ActionController
4+
# = Action Controller \Helpers
5+
#
46
# The \Rails framework provides a large number of helpers for working with assets, dates, forms,
57
# numbers and model objects, to name a few. These helpers are available to all templates
68
# by default.

actionpack/lib/action_controller/metal/live.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
require "active_support/json"
66

77
module ActionController
8-
# = Action Controller \Live
8+
# = Action Controller \Live
99
#
1010
# Mix this module into your controller, and all actions in that controller
1111
# will be able to stream data to the client as it's written.
@@ -66,6 +66,8 @@ def make_response!(request)
6666
end
6767
end
6868

69+
# = Action Controller \Live Server Sent Events
70+
#
6971
# This class provides the ability to write an SSE (Server Sent Event)
7072
# to an IO stream. The class is initialized with a stream and can be used
7173
# to either write a JSON string or an object which can be converted to JSON.

actionpack/lib/action_controller/metal/strong_parameters.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def initialize # :nodoc:
7171
class InvalidParameterKey < ArgumentError
7272
end
7373

74-
# == Action Controller \Parameters
74+
# = Action Controller \Parameters
7575
#
7676
# Allows you to choose which attributes should be permitted for mass updating
7777
# and thus prevent accidentally exposing that which shouldn't be exposed.
@@ -1177,7 +1177,7 @@ def initialize_copy(source)
11771177
end
11781178
end
11791179

1180-
# == Strong \Parameters
1180+
# = Strong \Parameters
11811181
#
11821182
# It provides an interface for protecting attributes from end-user
11831183
# assignment. This makes Action Controller parameters forbidden

actionpack/lib/action_controller/test_case.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,8 @@ def load!
232232
end
233233
end
234234

235+
# = Action Controller Test Case
236+
#
235237
# Superclass for ActionController functional tests. Functional tests allow you to
236238
# test a single controller action per test method.
237239
#

0 commit comments

Comments
 (0)