Skip to content

Improve grammar and expressions for American English #21184

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

Open
wants to merge 3 commits into
base: 7.3
Choose a base branch
from

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Jul 7, 2025

This PR addresses grammatical issues and non-idiomatic expressions throughout the Symfony documentation to make it more natural for native American English speakers, as requested in the issue.

Changes Made

Language Inclusivity

  • Replaced "master" terminology with more inclusive alternatives like "learn" and "understand"
  • Updated "dummy" references to use "test" in technical contexts

Grammar Fixes

  • Article usage: Fixed missing articles (e.g., "Easy way" → "An easy way")
  • Verb forms: Corrected constructions like "allow to define" → "allow you to define"
  • Word order: Fixed awkward ordering like "read first the" → "first read the" and "knowing first" → "first knowing"
  • Subject-verb agreement: Fixed "some part...which modify" → "some parts...that modify"
  • Prepositions: Improved usage like "know of:" → "know:"

Style Improvements

  • Replaced potentially problematic terms flagged by linting tools:
    • "straightforward" → "simple"
    • "just" → more specific alternatives like "only" or removed entirely
    • "more deeply" → "more"
  • Improved sentence flow with better conjunctions ("but is" → "but rather")
  • Added missing commas for clarity

Files Modified

  • page_creation.rst, routing.rst, security.rst, controller.rst
  • event_dispatcher.rst, http_cache.rst, mailer.rst, mercure.rst
  • messenger.rst, translation.rst, workflow.rst, cache.rst
  • configuration.rst, testing.rst, best_practices.rst, bundles.rst
  • deployment.rst, lock.rst, serializer.rst

Quality Assurance

  • Used Alex linting tool to identify language issues
  • Preserved all technical accuracy and meaning
  • Focused on high-traffic documentation files
  • Remaining linting warnings are mostly false positives for technical terms

These changes make the documentation more accessible and natural-sounding for native English speakers while maintaining the technical precision that developers expect.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@javiereguiluz javiereguiluz changed the title [WIP] Check the 6.4 banch. Most contributors are not native in English, so please find wrong expressions and grammar to make the docs look better for native American English speakers. [WIP] Check grammar Jul 7, 2025
@Copilot Copilot AI changed the title [WIP] Check grammar Improve grammar and expressions in Symfony documentation for native American English speakers Jul 7, 2025
@Copilot Copilot AI requested a review from javiereguiluz July 7, 2025 06:55
Copilot finished work on behalf of javiereguiluz July 7, 2025 06:55
@javiereguiluz javiereguiluz changed the title Improve grammar and expressions in Symfony documentation for native American English speakers Improve grammar and expressions for American English Jul 7, 2025
@javiereguiluz javiereguiluz marked this pull request as ready for review July 7, 2025 10:27
@javiereguiluz javiereguiluz added this to the 6.4 milestone Jul 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants