Skip to content

General grammar and style fixes in the book #4679

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

Merged
merged 4 commits into from
Dec 29, 2014

Conversation

frne
Copy link
Contributor

@frne frne commented Dec 23, 2014

Contains numerous grammar, style and readability fixes (see diff)

Q A
Doc fix? yes
New docs? no
Applies to >= 2.3
Fixed tickets

@@ -357,7 +357,7 @@ see the :ref:`book-doctrine-field-types` section.

.. note::

When using another library or program (ie. Doxygen) that uses annotations,
When using another library or program (i.e. Doxygen) that uses annotations,
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this actually be "e.g." instead of "i.e."?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@xabbuh Thx. fixed in 5c754e0

@wouterj
Copy link
Member

wouterj commented Dec 23, 2014

Wow, how did you find all these things? Just by reading it? Very great job!

I'll let @weaverryan merge this thing, as he has much more english skills than me.

@@ -177,7 +177,7 @@ of the application are isolated in a new file called ``model.php``:

.. tip::

The filename ``model.php`` is used because the logic and data access of
The file name ``model.php`` is used because the logic and data access of
Copy link
Member

Choose a reason for hiding this comment

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

I think filename is actually better - both are apparently valid, but one word yields many more Google results.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

IMHO, the difference here lays on the logical subject:

  • Subject on "the file" and "the name" as an attribute => "file name" (like "The file's name is...")
  • Subject on "the name of the file" => "filename" (like "The filename is too long...")

But to make it short, the term "filename" is - as you wrote - more common, and nobody cares about this tiny difference, so I'll change it back.

@weaverryan
Copy link
Member

Hey Frank!

Yea, wow, this is pretty amazing - I'm also amazed that you found so many things :). I've left a few small comments for discussion and this will be mergeable once we work those out.

Thanks!

@frne
Copy link
Contributor Author

frne commented Dec 23, 2014

@weaverryan Thanks for proofreading ;) On my way to propose some enhancements on the commented parts.

@frne
Copy link
Contributor Author

frne commented Dec 23, 2014

@weaverryan Some fixes in 86d7a6d

@wouterj I have to learn things in the book for my SF certification. So if I have to read the whole doc, I can as well proofread it and do something for the community.

@weaverryan
Copy link
Member

Well, we really appreciate you doing that :). And good luck on the exam!

@weaverryan weaverryan merged commit 86d7a6d into symfony:2.3 Dec 29, 2014
weaverryan added a commit that referenced this pull request Dec 29, 2014
This PR was merged into the 2.3 branch.

Discussion
----------

General grammar and style fixes in the book

Contains numerous grammar, style and readability fixes (see diff)

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | >= 2.3
| Fixed tickets |

Commits
-------

86d7a6d Some more fixes after proofreading
5c754e0 Fixes incorrect latin abbrev
7e4904f Merge remote-tracking branch 'upstream/2.3' into general-grammar-and-style-fixes
1da061c Some general grammar and style fixes in the book
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.

4 participants