-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Conversation
@@ -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, |
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.
Shouldn't this actually be "e.g." instead of "i.e."?
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.
…style-fixes Conflicts: book/forms.rst
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 |
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 think filename
is actually better - both are apparently valid, but one word yields many more Google results.
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.
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.
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! |
@weaverryan Thanks for proofreading ;) On my way to propose some enhancements on the commented parts. |
@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. |
Well, we really appreciate you doing that :). And good luck on the exam! |
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
Contains numerous grammar, style and readability fixes (see diff)