Attribute.php code snippet not properly escaped

Working on it.. and will share the solution soon.

This issue exists on `8.7.x` as well.

Here is the patch.

just removing assignment if it is now up for review ;-)

Just adding an Issue Summary Template and some tasks that help the reviewers (and committers!)

Looks like a couple of actions are needed, too, like how to reproduce

We can reproduce it by setting up -
https://www.drupal.org/docs/7/modules/api-module/create-your-own-api-7x-...

and then checking the documentation page for Attributes.php.

The issue is also visible here: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Template%...

Also, just a thought - phpcs does not even give a warning for this, should this also be included in Drupal coding standards?

This change does indeed stop the comment appearing in generated phpdocs.

Adding a test into phpcs makes sense. It's a different project, though, at drupal.org/project/coder and an issue should be raised there (referencing this one)

Setting to RTBC!

This is trickier though. This is twig code and not PHP code. We need our @code to be different code aware.

Created an issue for parsing twig comments in @code @endcode blocks - https://www.drupal.org/project/api/issues/3047324.

I think that the right solution here is actually to take the "Produces" part out of the @code/@endcode entirely. I don't see why it needs to be inside the code block at all?

Updating issue summary.

I have tagged this issue as Novice and Europe2020 for first time contributors at DrupalCon Europe. Thanks

After 11 December 2020, anyone can do this, but until then we are asking only participants in DrupalCon Europe first time contributors take this issue on. Thanks!

Does anyone know how to pass the error from test? It says the file does not exist, yet it should exist in 9.2-dev?

Hello: The patch looks rather unusual in its format. The expected patch format is the one that `git diff` creates. See https://www.drupal.org/docs/develop/git/using-git-to-contribute-to-drupa...

But in fact the reason it fails is because the patch is missing the core directory, as in core/lib/Drupal/Core/Template/Attribute.php.

Are you working with a Git checkout of Drupal core?

Yes I am working with a git checkout of drupal core. I used the "Create patch" function of PHPStorm, maybe that was the problem?

Yes, probably. In fact, the patch did contain the "core" directory. I was mistaken about that.

The automated tests use git apply <patch_file>.

That patch seems to work... and it looks good, except for the indentation:

  * been printed from being printed again. For example:
  * @code
  *  <cat class="{{ attributes.class }} my-custom-class"{{ attributes|without('class') }}>
- *  {# Produces <cat class="cat black-cat white-cat black-white-cat my-custom-class" id="socks"> #}
+ * @endcode
+ *  Produces:
+ * @code
+ *  <cat class="cat black-cat white-cat black-white-cat my-custom-class" id="socks">
  * @endcode
  *
  * The attribute keys and values are automatically escaped for output with

The "Produces" line and code lines are all indented by 1 space from the rest of the documentation. We would normally either want to indent things in doc blocks by 0 or 2 spaces. I see that the 1-space is consistent with the lines that were already in the code section... but can we fix it? Either remove the indentation or indent by 2 spaces. Thanks! I think removing the indentation would be best?

I'm assigning it to me.

I've created a patch and has implemented the changes suggested in #32. I've switched it from 1 space to 0 space as it was 0 in other files so just to keep it consistent.
Please review the patch and the interdiff.

Thanks for the patch!

Our practice in the Drupal core project is that one issue should cover one thing. This issue is only about fixing the part of Attribute.php that is described in the issue summary. So even though the rest of your fixes would be a good idea to do, we need the patch for this issue to only cover those few lines in Attribute.php.

Could you make another patch that only changes those few lines (which were changed correctly in the latest patch)? Thanks!

Thank you!

Committed/pushed to 9.2.x and cherry-picked to 9.1.x, thanks!