Docs - Plugin Handbook: Plugin header examples should not be in one line of code

[juanmaguitar]

As per feedback provided via Slack in the (Make WordPress) #docs channel

https://developer.wordpress.org/plugins/plugin-basics/header-requirements/
There is something wrong with docs.
plugin header should not be in one line of code

[justintadlock]

This looks like the same line break issue we had with the Dev Blog code syntax highlighter, which I believe uses a different plugin. We have the same issue on the Theme Handbook I noticed when adding new code blocks.

We implemented a quick fix for the Dev Blog here: WordPress/wporg-developer-blog#61

Related: WordPress/wporg-developer-blog#62

[ndiego]

cc @adamwoodnz

[adamwoodnz]

I tried deactivating the Code Syntax plugin and found that the code comments did render correctly, so it seems the plugin does strip <br> tags.

However, I just edited the code block, deleting the line break and doing a soft return in visual mode, and then switched to code mode and all the <br> tags were gone. The comments now display as expected on the frontend. Do we know how the <br> tags are being created to start with?

Are there other pages we can look at with this issue?

[adamwoodnz]

Looks like they were added by @audrasjb in this revision https://developer.wordpress.org/wp-admin/revision.php?revision=153510