-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Update routing.rst #3263
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
Update routing.rst #3263
Conversation
Added a note to provide extra guidance when naming routes
@@ -68,6 +68,13 @@ The route is simple: | |||
|
|||
return $collection; | |||
|
|||
.. note:: | |||
|
|||
When defining routes, the key (e.g. ``blog_show``) is meaningless. |
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.
it's not meaningless, you use it to reference to the route (for instance when generating a route in a template or controller)
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 concur. "Meaningless" is the wrong word. "Arbitrary" would be a better way of describing the route name.
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 we should move this to the last sentence of the next paragraph - so right after in your controller (keep reading).
- how about:
The
blog_show
is the internal name of the route, which just doesn't have any meaning yet and just needs to be unique. Later, you'll use it to generate URLs.
I think if we do this (feel free to re-word), then we're in good shape!
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.
We should at least avoid the first person perspective.
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.
Thanks - updated my example above!
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.
@fatmuemoo What do you think about my proposed change above? Can you update your PR? If not, just let me know and someone else can open a new PR with the tweak.
Cheers!
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 to me, thanks
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.
@fatmuemoo :) - ok - but can you also update your pull request with the suggested changes? I can also update it for you if you'd like!
Cheers!
Replaced by #3857 |
Added a note to provide extra guidance when naming routes