Skip to content

Commit 8f261cd

Browse files
Use headings for args documentation [ci-skip]
1 parent 3725de0 commit 8f261cd

File tree

6 files changed

+14
-9
lines changed

6 files changed

+14
-9
lines changed

actionview/lib/action_view/helpers/atom_feed_helper.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ def updated(date_or_time = nil)
170170

171171
# Creates an entry tag for a specific record and prefills the id using class and id.
172172
#
173-
# Options:
173+
# ==== Options
174174
#
175175
# * <tt>:published</tt>: Time first published. Defaults to the created_at attribute on the record if one such exists.
176176
# * <tt>:updated</tt>: Time of update. Defaults to the updated_at attribute on the record if one such exists.

actionview/lib/action_view/helpers/form_options_helper.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,8 @@ def option_groups_from_collection_for_select(collection, group_method, group_lab
495495
# <option value="France">France</option>
496496
# </optgroup>
497497
#
498-
# Parameters:
498+
# ==== Parameters
499+
#
499500
# * +grouped_options+ - Accepts a nested array or hash of strings. The first value serves as the
500501
# <tt><optgroup></tt> label while the second value must be an array of options. The second value can be a
501502
# nested array of text-value pairs. See <tt>options_for_select</tt> for more info.
@@ -506,7 +507,8 @@ def option_groups_from_collection_for_select(collection, group_method, group_lab
506507
# which will have the +selected+ attribute set. Note: It is possible for this value to match multiple options
507508
# as you might have the same option in multiple groups. Each will then get <tt>selected="selected"</tt>.
508509
#
509-
# Options:
510+
# ==== Options
511+
#
510512
# * <tt>:prompt</tt> - set to true or a prompt string. When the select element doesn't have a value yet, this
511513
# prepends an option with a generic prompt - "Please select" - or the given prompt string.
512514
# * <tt>:divider</tt> - the divider for the options groups.
@@ -598,7 +600,8 @@ def time_zone_options_for_select(selected = nil, priority_zones = nil, model = :
598600

599601
# Returns a string of option tags for the days of the week.
600602
#
601-
# Options:
603+
# ====Options
604+
#
602605
# * <tt>:index_as_value</tt> - Defaults to false, set to true to use the indexes from
603606
# <tt>I18n.translate("date.day_names")</tt> as the values. By default, Sunday is always 0.
604607
# * <tt>:day_format</tt> - The I18n key of the array to use for the weekday options.

activemodel/lib/active_model/validations.rb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ module ClassMethods
6363
# end
6464
# end
6565
#
66-
# Options:
66+
# ==== Options
67+
#
6768
# * <tt>:on</tt> - Specifies the contexts where this validation is active.
6869
# Runs in all validation contexts by default +nil+. You can pass a symbol
6970
# or an array of symbols. (e.g. <tt>on: :create</tt> or
@@ -134,7 +135,8 @@ def validates_each(*attr_names, &block)
134135
# Note that the return value of validation methods is not relevant.
135136
# It's not possible to halt the validate callback chain.
136137
#
137-
# Options:
138+
# ==== Options
139+
#
138140
# * <tt>:on</tt> - Specifies the contexts where this validation is active.
139141
# Runs in all validation contexts by default +nil+. You can pass a symbol
140142
# or an array of symbols. (e.g. <tt>on: :create</tt> or

activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module ConnectionAdapters
2525
#
2626
# The PostgreSQL adapter works with the native C (https://github.com/ged/ruby-pg) driver.
2727
#
28-
# Options:
28+
# ==== Options
2929
#
3030
# * <tt>:host</tt> - Defaults to a Unix-domain socket in /tmp. On machines without Unix-domain sockets,
3131
# the default is to connect to localhost.

activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module ConnectionAdapters # :nodoc:
2424
# The \SQLite3 adapter works with the sqlite3[https://sparklemotion.github.io/sqlite3-ruby/]
2525
# driver.
2626
#
27-
# Options:
27+
# ==== Options
2828
#
2929
# * +:database+ (String): Filesystem path to the database file.
3030
# * +:statement_limit+ (Integer): Maximum number of prepared statements to cache per database connection. (default: 1000)

activesupport/lib/active_support/lazy_load_hooks.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def self.extended(base) # :nodoc:
5353
# loaded. If the component has already loaded, the block is executed
5454
# immediately.
5555
#
56-
# Options:
56+
# ==== Options
5757
#
5858
# * <tt>:yield</tt> - Yields the object that run_load_hooks to +block+.
5959
# * <tt>:run_once</tt> - Given +block+ will run only once.

0 commit comments

Comments
 (0)