-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
spotted minor EN mistakes and coherence issues between the different … #14496
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
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.
Thank you.
Im usually a suspect for grammar mistakes but I think none of these were mine =)
@@ -64,6 +64,7 @@ PHP; it implements ``HttpKernelInterface`` and wraps another | |||
new HttpKernel\HttpCache\Store(__DIR__.'/../cache') | |||
); | |||
|
|||
/* $response variable used before and after this chapter -> keep it in this chapter for more global coherence? */ |
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.
Are you suggesting to rewrite like this:
$response = $framework->handle($request);
$response->send();
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.
Yes, this is the way it is implemented in the chapters before and after this one, so might be nice to keep it this way here to improve global coherence of the code.
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 agree with that.
Thank you
@@ -46,8 +46,8 @@ Update your framework so that it implements this interface:: | |||
} | |||
} | |||
|
|||
Even if this change looks not too complex, it brings us a lot! Let's talk about one of | |||
the most impressive one: transparent :doc:`HTTP caching </http_cache>` support. | |||
Even if this change doesn't look like much, it brings us a lot! Let's talk about one 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.
Can we rephrase this differently?
Not to say that any change is "small" or "simple".
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.
Maybe "Even if this change looks minor..." then?
It maintains the general idea that a little goes a long way, but doesn't suggest it's simple.
Or "With this change, a little goes a long way !"
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.
Or "With this change, a little goes a long way !"
Perfect!
Context for other reviewers: The change is to add an interface.
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.
Then I would go with:
"With this change, a little goes a long way! Let's talk about one of the most impressive upsides:"
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.
Sounds. good. Thank you.
/* all properties are now declared as private, they were protected until this chapter -> either there is a good reason and it might be useful to explain this change, or there could be better coherence by keeping them protected *or* private in the entire book */ | ||
|
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.
Nice catch, I added a PR #14501 are there any other occurrences I didn't catch?
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.
Excellent. These lines can now be removed.
Well done @OskarStark and @Ca-Jou 👍
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.
@OskarStark not that I'm aware of.
@Nyholm sorry for the newb question, but it's my first PR ever: am I supposed to remove these lines in my PR (by committing once more or editing this commit) now that another one has been opened?
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.
sorry for the newb question, but it's my first PR ever:
Congratulations. And what a great PR to start with =)
You can just make a new commit and push to the same branch (patch-create-framework). There is no need to be fancy and editing the commits etc.
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.
Thank you! This part of the docs does not get the attention it deserves. Great to have such detailed and correct fixes across the chapters!
Let me know if I can help you with something. Im available in the Symfony slack |
8416432
to
ae45622
Compare
@Ca-Jou thanks a lot for these super nice improvements! Thanks to reviewers too. What an amazing team work you all did in this PR! 👏 |
…chapters