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

Update documentation to include proper class name formatting and pron… #48286

Merged
merged 1 commit into from May 23, 2023
Merged

Update documentation to include proper class name formatting and pron… #48286

merged 1 commit into from May 23, 2023

Conversation

cjilbert504
Copy link
Contributor

@cjilbert504 cjilbert504 commented May 23, 2023

…oun problem fix

Motivation / Background

This Pull Request has been created to clarify the full class name to inherit from when creating additional system test classes and because of a pronoun problem.

Detail

This Pull Request changes the documentation to ensure accuracy by including the full class name with formatting. Previously, the class name ActionDispatch::SystemTestCase was missing proper formatting and the module name, resulting in potential confusion. Additionally, the commit addresses a pronoun fix by replacing "use in your test suite" with "use it in your test suite."

Additional information

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.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated 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.

@rails-bot rails-bot bot added the docs label May 23, 2023
@jonathanhefner jonathanhefner merged commit 0f5c8c5 into rails:main May 23, 2023
8 of 9 checks passed
@jonathanhefner
Copy link
Member

jonathanhefner commented May 23, 2023

Thank you, @cjilbert504! 📜

Backported to 7-0-stable.

@cjilbert504 cjilbert504 deleted the patch-2 branch May 23, 2023 20:00
@cjilbert504
Copy link
Contributor Author

Thank you, @jonathanhefner!!! 🖋️

jonathanhefner added a commit that referenced this pull request May 26, 2023
Update documentation to include proper class name formatting and pron… [ci-skip]

(cherry picked from commit 0f5c8c5)
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