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.

Sign up for GitHub

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

Jump to bottom

Capitalize heading to match style guidelines [ci-skip] #46250

Merged
merged 1 commit into from Oct 18, 2022
Merged

Capitalize heading to match style guidelines [ci-skip] #46250

merged 1 commit into from Oct 18, 2022

Conversation

missy-davies
Copy link
Contributor

@missy-davies missy-davies commented Oct 14, 2022 •
edited

Detail

According to the Ruby on Rails Guides Guidelines section on headings:

When writing headings, capitalize all words except for prepositions, conjunctions, internal articles, and forms of the verb "to be":

This PR reviews the capitalization of headings in all Rails Guides.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • There are no typos in commit messages and comments.
  • Commit message has a detailed description of what changed and why. If this PR fixes a relXted issue include it in the commit message. Ex: [Fix #issue-number]
  • Feature branch is up-to-date with main (if not - rebase it).
  • Pull request only contains one commit for bug fixes and small features. If it's a larger feature, multiple commits are permitted but must be descriptive.
  • Tests are added if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.
  • PR is not in a draft state.
  • CI is passing.

@rails-bot rails-bot bot added the docs label Oct 14, 2022
jonathanhefner
jonathanhefner reviewed Oct 15, 2022
View reviewed changes
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.

Looks like there are two more: "Available callbacks" and "Supported types for arguments". Since we are improving things, would you mind updating those too? 🙏

@jonathanhefner jonathanhefner changed the title Capitalize heading to match style guidelines Capitalize heading to match style guidelines [ci-skip] Oct 15, 2022
@missy-davies
Copy link
Contributor Author

Looks like there are two more: "Available callbacks" and "Supported types for arguments". Since we are improving things, would you mind updating those too? 🙏

Absolutely! I'm on it :)

@missy-davies
Copy link
Contributor Author

@jonathanhefner I took the opportunity to go through all the Rails Guides and fix header capitalizations :) Let me know if looks ok or if I got overzealous!

jonathanhefner
jonathanhefner reviewed Oct 16, 2022
View reviewed changes
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.

Wow! 😮 Just a few minor comments, but this looks great!

guides/source/active_model_basics.md Show resolved Hide resolved
guides/source/command_line.md Outdated Show resolved Hide resolved
guides/source/debugging_rails_applications.md Outdated Show resolved Hide resolved
guides/source/debugging_rails_applications.md Outdated Show resolved Hide resolved
guides/source/plugins.md Show resolved Hide resolved
@missy-davies
Capitalize headings to match style guidelines
d49a3ab 
Fix all headings to follow Rails Guides Guidelines
@missy-davies
Copy link
Contributor Author

Hi @jonathanhefner, it should be all set now - I applied your suggestions and fixed what you noted :)

@jonathanhefner jonathanhefner merged commit d322d9b into rails:main Oct 18, 2022
@jonathanhefner
Copy link
Member

jonathanhefner commented Oct 18, 2022 •
edited

Thank you, @missy-davies! 😃

Backported to 7-0-stable.

@missy-davies missy-davies deleted the md/capitalize-heading branch October 18, 2022 17:42
jonathanhefner added a commit that referenced this pull request Nov 19, 2022
@jonathanhefner
Merge pull request #46250 from missy-davies/md/capitalize-heading
93baca1 
Capitalize heading to match style guidelines [ci-skip]

(cherry picked from commit d322d9b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonathanhefner jonathanhefner jonathanhefner left review comments

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@missy-davies @jonathanhefner