meta: Close comment in PR template #40808
Conversation
github-actions
bot
added
system
| @@ -1,4 +1,4 @@ | |||
| <!-- 🙌 Thanks for contributing to MDN Web Docs. 🙌 | |||
| <!-- 🙌 Thanks for contributing to MDN Web Docs. 🙌 --> | |||
|
|
|||
| Add details below to help us review your pull request (PR). | |||
| Explain your changes and link to a related issue or pull request. | |||
There was a problem hiding this comment.
It's closed on L5 though, you can check here where it's un-modified: https://redirect.github.com/mdn/content/pull/40760
Would it be clearer if each line had open/close comment tags?
There was a problem hiding this comment.
Would it be clearer if each line had open/close comment tags?
100%. And as is, it results in an empty overall GitHub comment.
There was a problem hiding this comment.
Sorry I don't understand. What empty comment? If you post this template as-is you still see the headings because they are not inside any MD comment.
Also strong -1 to changing anything; adding comment markers to every line makes the explanation even harder to read.
There was a problem hiding this comment.
This is what my brain did:
"Ah, comment on line 1, and placeholder explanation text on the following lines, let's get rid of it."
After that, you end up with the unclosed comment.
There was a problem hiding this comment.
How about we add line breaks around the comment markers so it's more salient that they are multiline?
<!--
Blah blah
Blah blah
-->There was a problem hiding this comment.
I have updated the PR to do that in 9846c42.
github-actions
bot
added
size/s
|
I'm good with this |
No description provided.