Skip to content

[book] routing ch review, part 1 #6354

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

Closed
wants to merge 3 commits into from
Closed

[book] routing ch review, part 1 #6354

wants to merge 3 commits into from

Conversation

talitakz
Copy link
Contributor

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets no

Among other things I squashed subtitle "Routing in Action" with "Routing with Placeholders" since it was dealing with the same thing - the same code example.

@talitakz talitakz changed the title routing ch review, part 1 [book] routing ch review, part 1 Mar 12, 2016

This is the goal of the Symfony router: to map the URL of a request to a
controller. Along the way, you'll learn all sorts of tricks that make mapping
even the most complex URLs easy.
Copy link
Member

Choose a reason for hiding this comment

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

Ah, but we could probably keep this section and delete everything else - this is the heart of this document :). If I understand it correctly, now the first routing example will be very far down on the page, after a lot of boring paragraphs (people skip this mostly and look for code blocks).

In other words, I think this should stay!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

To explain my proposed changes. Before my proposed change the chapter looked like this:

First there was "Routing in Action" sub-title with @Route("/blog/{slug}", name="blog_show") example and upper description. Then there were request flow and some configuration sub-titles fallowed by "Basic Route Configuration" sub-title with @Route("/") routing example. The thing that bothered me was that after all this there was "Routing with Placeholders" sub-title with exactly the same example as "Routing in Action" sub-title. So both subtitles were essentially the same and more complex example @Route("/blog/{slug}", name="blog_show") was before more simple one @Route("/") and to a beginner example explanation therefore probably didn't make much sense until latter. This is the reason i proposed the squash of the two sub-titles - "Basic Route Configuration" and "Routing with Placeholders". Nothing was removed. The explanation in this squashed sub-title is even better then before and the chapter flow now progresses from easy and simple to more complex examples instead of from complex (with no background) to simple and to more complex again... So the heart of this chapter was not removed just improved but yes, like you said, moved just a little bit further down but i still don't think that further down (lines 202-311) :)

@weaverryan
Copy link
Member

Hey @paxyknox!

I just made some comments on this PR and the next one. Can you update them? Honestly, these contain some good changes, but they are a lot of work to review - it's all I've been doing for about 1 hour now :). If you're able to make some changes "smaller" - i.e. keep the most important ones, it will help to review them.

But thank you for the contributions - I just want to make sure we are able to review things efficiently - we have short time.

@talitakz
Copy link
Contributor Author

I made suggested changes. Yes, I almost have a bad consciousness because these chapters are so big and therefore there is much to review. But i could't do this just partially. I think it deserves a proper improvement as a hole - for all of us. :)

@weaverryan
Copy link
Member

Closing: see #6252 (comment)

@weaverryan weaverryan closed this Jul 10, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants