Skip to content

Added missing code-block php #3632

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

Closed
wants to merge 1 commit into from
Closed

Added missing code-block php #3632

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions cookbook/security/voters_data_permission.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Creating the Custom Voter
The goal is to create a voter that checks if a user has access to view or
edit a particular object. Here's an example implementation:

.. code-block:: php
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe it is better to add :: on line 57 above?

Copy link
Member

Choose a reason for hiding this comment

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

yes, that's our standard

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you mean ? I am no specialist of this kind of markup, i just followed the documentation to use the php syntax coloration. If there is a better way to do it feel free to make a separate change to the doc.

Copy link
Member

Choose a reason for hiding this comment

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

@DerekRoth please note that I really appreciate that you take the time do fix the docs. That's really lovely.

However, this can be done a bit better. Instead of using .. code-block:: php, you can also end the last sentence before the code block with a double colon: ::. This will highlight the comming code block as a PHP code block (since it's the default language on symfony.com) and it'll replace it with a single colon, so that everything renders as expected.

So if you can change it to this, I'll be very happy, otherwise this is fine too :)

edit a particular object. Here's an example implementation::

    // src/Acme/DemoBundle/Security/Authorization/Voter/PostVoter.php

Diff:

-edit a particular object. Here's an example implementation:
+edit a particular object. Here's an example implementation::
-
-.. code-block:: php

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK thank you, i understand now. It was misleading that a few lines below, the full "code-block" syntax was used for a php code sample, maybe it should be changed too.

Copy link
Member

Choose a reason for hiding this comment

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

The next code block is inside a configuration block which can't be abbreviated like we could do it here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was talking about the next PHP code block in the page, in "How to Use the Voter in a Controller".

Copy link
Member

Choose a reason for hiding this comment

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

@DerekRoth that's because using the :: shortcut will always result in a colon displayed on the page. In the next PHP code block, you can see that the last sentence ends with a full stop (.) and not with a colon, so we can't use the :: shortcut and we have to fall back to the .. code-block:: php way.


// src/Acme/DemoBundle/Security/Authorization/Voter/PostVoter.php
namespace Acme\DemoBundle\Security\Authorization\Voter;

Expand Down