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

Improve casing in encryption guide headings [ci-skip] #43120

Merged
merged 1 commit into from
Aug 28, 2021

Conversation

p8
Copy link
Member

@p8 p8 commented Aug 27, 2021

Summary

Update the guide to use the casing as defined in the contribution guide.
https://guides.rubyonrails.org/ruby_on_rails_guides_guidelines.html#headings

Copy link
Member

@jonathanhefner jonathanhefner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused by the casing on some of these. Perhaps the result of an incomplete regexp find / replace? I commented on a few to illustrate what I mean.

guides/source/active_record_encryption.md Outdated Show resolved Hide resolved
guides/source/active_record_encryption.md Outdated Show resolved Hide resolved
guides/source/active_record_encryption.md Outdated Show resolved Hide resolved
guides/source/active_record_encryption.md Outdated Show resolved Hide resolved
@jonathanhefner jonathanhefner changed the title Improve casing in encryption guide headings Improve casing in encryption guide headings [ci-skip] Aug 27, 2021
@p8 p8 force-pushed the guides/encryption-headings branch 2 times, most recently from 0b3432e to 9793549 Compare August 27, 2021 21:03
Copy link
Member

@jonathanhefner jonathanhefner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My previous suggestions weren't an exhaustive list, but I've added suggestions for the remaining few. Thank you for working on this, @p8! 🙌

guides/source/active_record_encryption.md Outdated Show resolved Hide resolved
guides/source/active_record_encryption.md Outdated Show resolved Hide resolved
@@ -460,7 +460,7 @@ class Attribute
end
```

#### Encryption context when running a block of code
#### Encryption Context when running a Block of Code
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Encryption Context when running a Block of Code
#### Encryption Context When Running a Block of Code

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't when a conjunction?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most style guides I see (e.g. The Associated Press Stylebook) specify prepositions with three letters or fewer, such as "and", "but", "nor", and "or". I think that may have been the intention in the Rails style guide.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is an interesting list: https://titlecaseconverter.com/rules/. "when" is classified as a subordinating conjunction (TIL!). In the comparison table at the bottom of the page, it suggests that subordinating conjunctions other than "as" or "if" should be capitalized, according to each listed style guide.

guides/source/active_record_encryption.md Outdated Show resolved Hide resolved
@p8 p8 force-pushed the guides/encryption-headings branch 2 times, most recently from 63c1144 to e3ce62e Compare August 27, 2021 21:21
Update the guide to use the casing as defined in the contribution guide.
https://guides.rubyonrails.org/ruby_on_rails_guides_guidelines.html#headings
[ci-skip]

Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
@jonathanhefner
Copy link
Member

It's possible that I will be unavailable for the next several days, so I went ahead and force-pushed a commit to capitalize "when". Thank you again, @p8! 😃

@jonathanhefner jonathanhefner merged commit 6bd3925 into rails:main Aug 28, 2021
@p8 p8 deleted the guides/encryption-headings branch August 28, 2021 08:11
@p8
Copy link
Member Author

p8 commented Aug 28, 2021

Thanks for the quick review and fix @jonathanhefner! 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants