Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix RDOC headings for Action View Helpers [ci-skip] #47831

Merged
merged 1 commit into from
Apr 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/active_model_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
require "active_support/core_ext/enumerable"

module ActionView
# = Active Model Helpers
module Helpers # :nodoc:
module ActiveModelHelper
end

# = Active \Model Instance Tag \Helpers
module ActiveModelInstanceTag
def object
@active_model_object ||= begin
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/asset_tag_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
require "action_view/helpers/tag_helper"

module ActionView
# = Action View Asset Tag Helpers
module Helpers # :nodoc:
# = Action View Asset Tag \Helpers
#
# This module provides methods for generating HTML that links views to assets such
# as images, JavaScripts, stylesheets, and feeds. These methods do not verify
# the assets exist before linking to them:
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/asset_url_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
require "zlib"

module ActionView
# = Action View Asset URL Helpers
module Helpers # :nodoc:
# = Action View Asset URL \Helpers
#
# This module provides methods for generating asset paths and
# URLs.
#
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/atom_feed_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
require "set"

module ActionView
# = Action View Atom Feed Helpers
module Helpers # :nodoc:
# = Action View Atom Feed \Helpers
module AtomFeedHelper
# Adds easy defaults to writing Atom feeds with the Builder template engine (this does not work on ERB or any other
# template languages).
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/cache_helper.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# frozen_string_literal: true

module ActionView
# = Action View Cache Helper
module Helpers # :nodoc:
# = Action View Cache \Helpers
module CacheHelper
class UncacheableFragmentError < StandardError; end

Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/capture_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
require "active_support/core_ext/string/output_safety"

module ActionView
# = Action View Capture Helper
module Helpers # :nodoc:
# = Action View Capture \Helpers
#
# \CaptureHelper exposes methods to let you extract generated markup which
# can be used in other parts of a template or layout file.
#
Expand Down
2 changes: 2 additions & 0 deletions actionview/lib/action_view/helpers/controller_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

module ActionView
module Helpers # :nodoc:
# = Action View Controller \Helpers
#
# This module keeps all methods and behavior in ActionView
# that simply delegates to the controller.
module ControllerHelper # :nodoc:
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/csp_helper.rb
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# frozen_string_literal: true

module ActionView
# = Action View CSP Helper
module Helpers # :nodoc:
module CspHelper
# = Action View CSP \Helpers
#
# Returns a meta tag "csp-nonce" with the per-session nonce value
# for allowing inline <script> tags.
#
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/csrf_helper.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# frozen_string_literal: true

module ActionView
# = Action View CSRF Helper
module Helpers # :nodoc:
# = Action View CSRF \Helpers
module CsrfHelper
# Returns meta tags "csrf-param" and "csrf-token" with the name of the cross-site
# request forgery protection parameter and token, respectively.
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/date_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

module ActionView
module Helpers # :nodoc:
# = Action View Date Helpers
# = Action View Date \Helpers
#
# The Date Helper primarily creates select/option tags for different kinds of dates and times or date and time
# elements. All of the select-type methods share a number of common options that are as follows:
Expand Down
6 changes: 3 additions & 3 deletions actionview/lib/action_view/helpers/debug_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
require "action_view/helpers/tag_helper"

module ActionView
# = Action View Debug Helper
#
# Provides a set of methods for making it easier to debug Rails objects.
module Helpers # :nodoc:
# = Action View Debug \Helpers
#
# Provides a set of methods for making it easier to debug Rails objects.
module DebugHelper
include TagHelper

Expand Down
5 changes: 4 additions & 1 deletion actionview/lib/action_view/helpers/form_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
require "active_support/core_ext/string/inflections"

module ActionView
# = Action View Form Helpers
module Helpers # :nodoc:
# = Action View Form \Helpers
#
# Form helpers are designed to make working with resources much easier
# compared to using vanilla HTML.
#
Expand Down Expand Up @@ -1620,6 +1621,8 @@ def default_form_builder_class
end
end

# = Action View Form Builder
#
# A +FormBuilder+ object is associated with a particular model object and
# allows you to generate fields associated with the model object. The
# +FormBuilder+ object is yielded when using +form_for+ or +fields_for+.
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/form_options_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
require "action_view/helpers/text_helper"

module ActionView
# = Action View Form Option Helpers
module Helpers # :nodoc:
# = Action View Form Option \Helpers
#
# Provides a number of methods for turning different kinds of containers into a set of option tags.
#
# The <tt>collection_select</tt>, <tt>select</tt> and <tt>time_zone_select</tt> methods take an <tt>options</tt> parameter, a hash:
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/form_tag_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
require "active_support/core_ext/module/attribute_accessors"

module ActionView
# = Action View Form Tag Helpers
module Helpers # :nodoc:
# = Action View Form Tag \Helpers
#
# Provides a number of methods for creating form tags that don't rely on an Active Record object assigned to the template like
# FormHelper does. Instead, you provide the names and values manually.
#
Expand Down
1 change: 1 addition & 0 deletions actionview/lib/action_view/helpers/javascript_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

module ActionView
module Helpers # :nodoc:
# = Action View JavaScript \Helpers
module JavaScriptHelper
JS_ESCAPE_MAP = {
"\\" => "\\\\",
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/number_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
require "active_support/number_helper"

module ActionView
# = Action View Number Helpers
module Helpers # :nodoc:
# = Action View Number \Helpers
#
# Provides methods for converting numbers into formatted strings.
# Methods are provided for phone numbers, currency, percentage,
# precision, positional notation, file size, and pretty printing.
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/output_safety_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
require "active_support/core_ext/string/output_safety"

module ActionView # :nodoc:
# = Action View Raw Output Helper
module Helpers # :nodoc:
# = Action View Raw Output \Helpers
module OutputSafetyHelper
# This method outputs without escaping a string. Since escaping tags is
# now default, this can be used when you don't want Rails to automatically
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/rendering_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

module ActionView
module Helpers # :nodoc:
# = Action View Rendering
# = Action View Rendering \Helpers
#
# Implements methods that allow rendering from a view context.
# In order to use this module, all you need is to implement
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/sanitize_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
require "rails-html-sanitizer"

module ActionView
# = Action View Sanitize Helpers
module Helpers # :nodoc:
# = Action View Sanitize \Helpers
#
# The SanitizeHelper module provides a set of methods for scrubbing text of undesired HTML elements.
# These helper methods extend Action View making them callable within your template files.
module SanitizeHelper
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/tag_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
require "action_view/helpers/output_safety_helper"

module ActionView
# = Action View Tag Helpers
module Helpers # :nodoc:
# = Action View Tag \Helpers
#
# Provides methods to generate HTML tags programmatically both as a modern
# HTML5 compliant builder style and legacy XHTML compliant tags.
module TagHelper
Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/text_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
require "action_view/helpers/output_safety_helper"

module ActionView
# = Action View Text Helpers
module Helpers # :nodoc:
# = Action View Text \Helpers
#
# The TextHelper module provides a set of methods for filtering, formatting
# and transforming strings, which can reduce the amount of inline Ruby code in
# your views. These helper methods extend Action View making them callable
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/helpers/translation_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
require "active_support/html_safe_translation"

module ActionView
# = Action View Translation Helpers
module Helpers # :nodoc:
# = Action View Translation \Helpers
module TranslationHelper
extend ActiveSupport::Concern

Expand Down
3 changes: 2 additions & 1 deletion actionview/lib/action_view/helpers/url_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
require "action_view/helpers/tag_helper"

module ActionView
# = Action View URL Helpers
module Helpers # :nodoc:
# = Action View URL \Helpers
#
# Provides a set of methods for making links and getting URLs that
# depend on the routing subsystem (see ActionDispatch::Routing).
# This allows you to use the same format for links in views
Expand Down