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.

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

docs: fix the cookbook_fixers.rst #6672

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/cookbook_fixers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Step by step
------------

For this step-by-step, we are going to create a simple fixer that
removes all comments from the code that are preceded by ';' (semicolon).
removes all comments from the code that are preceded by `;` (semicolon).

We are calling it ``remove_comments`` (code name), or,
``RemoveCommentsFixer`` (class name).
Expand Down Expand Up @@ -263,10 +263,10 @@ First, we need to create one method to describe what this fixer does:
public function getDefinition()
{
return new FixerDefinition(
'Removes all comments of the code that are preceded by ";" (semicolon).', // Trailing dot is important. We thrive to use English grammar properly.
'Removes all comments of the code that are preceded by `;` (semicolon).', // Trailing dot is important. We thrive to use English grammar properly.
[
new CodeSample(
'<?php echo 123; /* Comment */'
"<?php echo 123; /* Comment */\n"
),
]
);
Expand Down Expand Up @@ -442,10 +442,10 @@ So the fixer in the end looks like this:
public function getDefinition()
{
return new FixerDefinition(
'Removes all comments of the code that are preceded by ";" (semicolon).', // Trailing dot is important. We thrive to use English grammar properly.
'Removes all comments of the code that are preceded by `;` (semicolon).', // Trailing dot is important. We thrive to use English grammar properly.
[
new CodeSample(
'<?php echo 123; /* Comment */'
"<?php echo 123; /* Comment */\n"
),
]
);
Expand Down