Skip to content

Commit d322d9b

Browse files
Merge pull request rails#46250 from missy-davies/md/capitalize-heading
Capitalize heading to match style guidelines [ci-skip]
2 parents 86cc3a0 + d49a3ab commit d322d9b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+150
-150
lines changed

guides/source/action_cable_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -792,7 +792,7 @@ connections as you have workers. The default worker pool size is set to 4, so
792792
that means you have to make at least 4 database connections available.
793793
You can change that in `config/database.yml` through the `pool` attribute.
794794
795-
### Client-side logging
795+
### Client-side Logging
796796
797797
Client-side logging is disabled by default. You can enable this by setting the `ActionCable.logger.enabled` to true.
798798

guides/source/action_controller_overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ When this form is submitted, the value of `params[:client]` will be `{ "name" =>
142142

143143
The `params` object acts like a Hash, but lets you use symbols and strings interchangeably as keys.
144144

145-
### JSON parameters
145+
### JSON Parameters
146146

147147
If you're writing a web service application, you might find yourself more comfortable accepting parameters in JSON format. If the "Content-Type" header of your request is set to "application/json", Rails will automatically load your parameters into the `params` hash, which you can access as you would normally.
148148

@@ -680,7 +680,7 @@ If you use the cookie session store, this would apply to the `session` and
680680

681681
[`cookies`]: https://api.rubyonrails.org/classes/ActionController/Cookies.html#method-i-cookies
682682

683-
Rendering XML and JSON data
683+
Rendering XML and JSON Data
684684
---------------------------
685685

686686
ActionController makes it extremely easy to render `XML` or `JSON` data. If you've generated a controller using scaffolding, it would look something like this:
@@ -1274,7 +1274,7 @@ NOTE: Certain exceptions are only rescuable from the `ApplicationController` cla
12741274

12751275
[`rescue_from`]: https://api.rubyonrails.org/classes/ActiveSupport/Rescuable/ClassMethods.html#method-i-rescue_from
12761276

1277-
Force HTTPS protocol
1277+
Force HTTPS Protocol
12781278
--------------------
12791279

12801280
If you'd like to ensure that communication to your controller is only possible

guides/source/action_mailbox_basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,15 +340,15 @@ your job queue being able to hold jobs for that long.)
340340

341341
[`config.action_mailbox.incinerate_after`]: configuring.html#config-action-mailbox-incinerate-after
342342

343-
## Working with Action Mailbox in development
343+
## Working with Action Mailbox in Development
344344

345345
It's helpful to be able to test incoming emails in development without actually
346346
sending and receiving real emails. To accomplish this, there's a conductor
347347
controller mounted at `/rails/conductor/action_mailbox/inbound_emails`,
348348
which gives you an index of all the InboundEmails in the system, their
349349
state of processing, and a form to create a new InboundEmail as well.
350350

351-
## Testing mailboxes
351+
## Testing Mailboxes
352352

353353
Example:
354354

guides/source/action_mailer_basics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ What is Action Mailer?
2222
Action Mailer allows you to send emails from your application using mailer classes
2323
and views.
2424

25-
### Mailers are similar to controllers
25+
### Mailers are Similar to Controllers
2626

2727
They inherit from [`ActionMailer::Base`][] and live in `app/mailers`. Mailers also work
2828
very similarly to controllers. Some examples of similarities are enumerated below.
@@ -259,7 +259,7 @@ access it with the [`message`][] method on the `ActionMailer::MessageDelivery` o
259259
[`message`]: https://api.rubyonrails.org/classes/ActionMailer/MessageDelivery.html#method-i-message
260260
[`with`]: https://api.rubyonrails.org/classes/ActionMailer/Parameterized/ClassMethods.html#method-i-with
261261

262-
### Auto encoding header values
262+
### Auto Encoding Header Values
263263

264264
Action Mailer handles the auto encoding of multibyte characters inside of
265265
headers and bodies.
@@ -352,7 +352,7 @@ Action Mailer 3.0 makes inline attachments, which involved a lot of hacking in p
352352
<%= image_tag attachments['image.jpg'].url, alt: 'My Photo', class: 'photos' %>
353353
```
354354

355-
#### Sending Email To Multiple Recipients
355+
#### Sending Email to Multiple Recipients
356356

357357
It is possible to send email to one or more recipients in one email (e.g.,
358358
informing all admins of a new signup) by setting the list of emails to the `:to`
@@ -374,7 +374,7 @@ end
374374
The same format can be used to set carbon copy (Cc:) and blind carbon copy
375375
(Bcc:) recipients, by using the `:cc` and `:bcc` keys respectively.
376376

377-
#### Sending Email With Name
377+
#### Sending Email with Name
378378

379379
Sometimes you wish to show the name of the person instead of just their email
380380
address when they receive the email. You can use [`email_address_with_name`][] for
@@ -473,7 +473,7 @@ You can also consider using the [`append_view_path`][] method.
473473
[`append_view_path`]: https://api.rubyonrails.org/classes/ActionView/ViewPaths/ClassMethods.html#method-i-append_view_path
474474
[`prepend_view_path`]: https://api.rubyonrails.org/classes/ActionView/ViewPaths/ClassMethods.html#method-i-prepend_view_path
475475

476-
#### Caching mailer view
476+
#### Caching Mailer View
477477

478478
You can perform fragment caching in mailer views like in application views using the [`cache`][] method.
479479

@@ -625,7 +625,7 @@ NOTE: non-`GET` links require [rails-ujs](https://github.com/rails/rails/blob/ma
625625
[jQuery UJS](https://github.com/rails/jquery-ujs), and won't work in mailer templates.
626626
They will result in normal `GET` requests.
627627

628-
### Adding images in Action Mailer Views
628+
### Adding Images in Action Mailer Views
629629

630630
Unlike controllers, the mailer instance doesn't have any context about the
631631
incoming request so you'll need to provide the `:asset_host` parameter yourself.

guides/source/action_text_overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ RichText model that's associated with any existing Active Record model in the ap
2525
Any embedded images (or other attachments) are automatically stored using
2626
Active Storage and associated with the included RichText model.
2727

28-
## Trix compared to other rich text editors
28+
## Trix Compared to Other Rich Text Editors
2929

3030
Most WYSIWYG editors are wrappers around HTML’s `contenteditable` and `execCommand` APIs,
3131
designed by Microsoft to support live editing of web pages in Internet Explorer 5.5,
@@ -61,7 +61,7 @@ After the installation is complete, a Rails app should have the following change
6161

6262
2. The `trix` stylesheet will be included together with Action Text styles in your `application.css` file.
6363

64-
## Creating Rich Text content
64+
## Creating Rich Text Content
6565

6666
Add a rich text field to an existing model:
6767

@@ -111,7 +111,7 @@ end
111111

112112
[`rich_text_area`]: https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-rich_text_area
113113

114-
## Rendering Rich Text content
114+
## Rendering Rich Text Content
115115

116116
By default, Action Text will render rich text content inside an element with the
117117
`.trix-content` class:
@@ -214,7 +214,7 @@ By default, all `ActiveRecord::Base` descendants mix-in
214214

215215
[global-id]: https://github.com/rails/globalid#usage
216216

217-
## Avoid N+1 queries
217+
## Avoid N+1 Queries
218218

219219
If you wish to preload the dependent `ActionText::RichText` model, assuming your rich text field is named `content`, you can use the named scope:
220220

@@ -223,7 +223,7 @@ Message.all.with_rich_text_content # Preload the body without attachments.
223223
Message.all.with_rich_text_content_and_embeds # Preload both body and attachments.
224224
```
225225

226-
## API / Backend development
226+
## API / Backend Development
227227

228228
1. A backend API (for example, using JSON) needs a separate endpoint for uploading files that creates an `ActiveStorage::Blob` and returns its `attachable_sgid`:
229229

guides/source/action_view_helpers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ After reading this guide, you will know:
1212

1313
--------------------------------------------------------------------------------
1414

15-
Overview of helpers provided by Action View
15+
Overview of Helpers Provided by Action View
1616
-------------------------------------------
1717

1818
WIP: Not all the helpers are listed here. For a full list see the [API documentation](https://api.rubyonrails.org/classes/ActionView/Helpers.html)

guides/source/action_view_overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ This will render a file named `_menu.html.erb` at that point within the view tha
204204

205205
That code will pull in the partial from `app/views/shared/_menu.html.erb`.
206206

207-
#### Using Partials to simplify Views
207+
#### Using Partials to Simplify Views
208208

209209
One way to use partials is to treat them as the equivalent of subroutines; a way to move details out of a view so that you can grasp what's going on more easily. For example, you might have a view that looks like this:
210210

@@ -223,7 +223,7 @@ One way to use partials is to treat them as the equivalent of subroutines; a way
223223

224224
Here, the `_ad_banner.html.erb` and `_footer.html.erb` partials could contain content that is shared among many pages in your application. You don't need to see the details of these sections when you're concentrating on a particular page.
225225

226-
#### `render` without `partial` and `locals` options
226+
#### `render` without `partial` and `locals` Options
227227

228228
In the above example, `render` takes 2 options: `partial` and `locals`. But if
229229
these are the only options you want to pass, you can skip using these options.
@@ -239,7 +239,7 @@ You can also do:
239239
<%= render "product", product: @product %>
240240
```
241241

242-
#### The `as` and `object` options
242+
#### The `as` and `object` Options
243243

244244
By default `ActionView::Partials::PartialRenderer` has its object in a local variable with the same name as the template. So, given:
245245

@@ -398,7 +398,7 @@ views are located. By default, it only looks inside the `app/views` directory.
398398
We can add other locations and give them certain precedence when resolving
399399
paths using the `prepend_view_path` and `append_view_path` methods.
400400

401-
### Prepend view path
401+
### Prepend View Path
402402

403403
This can be helpful for example when we want to put views inside a different
404404
directory for subdomains.
@@ -411,7 +411,7 @@ prepend_view_path "app/views/#{request.subdomain}"
411411

412412
Then Action View will look first in this directory when resolving views.
413413

414-
### Append view path
414+
### Append View Path
415415

416416
Similarly, we can append paths:
417417

guides/source/active_job_basics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ class ApplicationJob < ActiveJob::Base
343343
end
344344
```
345345

346-
### Available callbacks
346+
### Available Callbacks
347347

348348
* [`before_enqueue`][]
349349
* [`around_enqueue`][]
@@ -394,7 +394,7 @@ UserMailer.welcome(@user).deliver_later # Email will be localized to Esperanto.
394394
```
395395

396396

397-
Supported types for arguments
397+
Supported Types for Arguments
398398
----------------------------
399399

400400
ActiveJob supports the following types of arguments by default:
@@ -513,7 +513,7 @@ If an exception from a job is not rescued, then the job is referred to as "faile
513513

514514
[`rescue_from`]: https://api.rubyonrails.org/classes/ActiveSupport/Rescuable/ClassMethods.html#method-i-rescue_from
515515

516-
### Retrying or Discarding failed jobs
516+
### Retrying or Discarding Failed Jobs
517517

518518
A failed job will not be retried, unless configured otherwise.
519519

guides/source/active_model_basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ class Person
203203
end
204204
```
205205

206-
#### Querying object directly for its list of all changed attributes.
206+
#### Querying an Object Directly for its List of All Changed Attributes
207207

208208
```irb
209209
irb> person = Person.new
@@ -231,7 +231,7 @@ irb> person.changes
231231
=> {"first_name"=>[nil, "First Name"]}
232232
```
233233

234-
#### Attribute-based accessor methods
234+
#### Attribute-based Accessor Methods
235235

236236
Track whether the particular attribute has been changed or not.
237237

guides/source/active_record_encryption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ But, under the hood, the executed SQL looks like this:
6666
INSERT INTO `articles` (`title`) VALUES ('{\"p\":\"n7J0/ol+a7DRMeaE\",\"h\":{\"iv\":\"DXZMDWUKfp3bg/Yu\",\"at\":\"X1/YjMHbHD4talgF9dt61A==\"}}')
6767
```
6868

69-
#### Important: About storage and column size
69+
#### Important: About Storage and Column Size
7070

7171
Encryption requires extra space because of Base64 encoding and the metadata stored along with the encrypted payloads. When using the built-in envelope encryption key provider, you can estimate the worst-case overhead at around 255 bytes. This overhead is negligible at larger sizes. Not only because it gets diluted but because the library uses compression by default, which can offer up to 30% storage savings over the unencrypted version for larger payloads.
7272

0 commit comments

Comments
 (0)