-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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
Conversation
There was a problem hiding this 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.
0b3432e
to
9793549
Compare
There was a problem hiding this 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! 🙌
@@ -460,7 +460,7 @@ class Attribute | |||
end | |||
``` | |||
|
|||
#### Encryption context when running a block of code | |||
#### Encryption Context when running a Block of Code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#### Encryption Context when running a Block of Code | |
#### Encryption Context When Running a Block of Code |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
63c1144
to
e3ce62e
Compare
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>
e3ce62e
to
4fae79a
Compare
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! 😃 |
Thanks for the quick review and fix @jonathanhefner! 😄 |
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