Skip to content
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.

Sign up for GitHub

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

Routing: add explanation for the "_fragment" parameter #6783

Closed
wants to merge 2 commits into from
Closed

Routing: add explanation for the "_fragment" parameter #6783

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34de06a
Routing: add explanation for the "_fragment" parameter
Jul 29, 2016
0791e48
Routing: add "versionadded" for the "_fragment" parameter
alexislefebvre Aug 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion routing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ Special Routing Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~

As you've seen, each routing parameter or default value is eventually available
as an argument in the controller method. Additionally, there are three parameters
as an argument in the controller method. Additionally, there are four parameters
that are special: each adds a unique piece of functionality inside your application:

``_controller``
Expand All @@ -475,6 +475,14 @@ that are special: each adds a unique piece of functionality inside your applicat
``_format``
Used to set the request format (:ref:`read more <routing-format-param>`).

``_fragment``
Copy link
Member

Choose a reason for hiding this comment

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

IMO, this is the wrong place for it, as you won't use _fragment in route patterns.

It should rather be explained in a section near Generating URLs with Query Strings


.. versionadded:: 3.2
Copy link
Member

Choose a reason for hiding this comment

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

I know it's a bit verbose, but in Symfony Docs the versionadded directive is used like this:

.. versionadded:: 3.2
    The ``_fragment`` parameter was introduced in Symfony 3.2.

The ``_fragment`` parameter was introduced in Symfony 3.2.

Used to set the fragment identifier, the optional last part of a URL that
starts with a ``#`` character and is used to identify a portion of a document.

``_locale``
Used to set the locale on the request (:ref:`read more <translation-locale-url>`).

Expand Down