Improving the readability of automated plugin issues

[htunnicliff]

I'd like to propose that the issue descriptions managed by CI (e.g. #1170) receive a few updates to improve readability:

• Replace ✨ with ✅
  • A check mark is more readily associated with something being finished or done
  • The yellow is harder to see against a bright background
• Sort the rules in each table in alphabetical order
• Make the name of each rule a hyperlink to that rule's docs
  • The full links in the "Docs" column take up a lot of space
• Add a column "Rationale" that provides an explanation for why an unimplemented rule (🚫) was not implemented
  • These would need to be filled in manually, but it could be really helpful to have this

What do maintainers think about this? I'd be happy to make the necessary PRs if these changes are welcome!

[camc314]

these suggestions sound great!

Add a column "Rationale" that provides an explanation for why an unimplemented rule

could we do this as a tooltip?

[htunnicliff]

I don't see why not!

By tooltip, are you referring to a footnote?

[camc314]

Ideally show on hover, but not sure if github's markdown flavour supports this.

footnote would also be an equally good solution. I'm just trying to avoid the table getting too complex to read/cols too wide/narrow.

[connorshea]

You can get hover text like this, I don't know of a better way to show it in GitHub Markdown because the dotted-underline isn't possible as far as I can tell and they strip out <abbr> elements.

<span title="Your tooltip text"><ins>Hover over me</ins></span>

[camc314]

lets use footnotes?

[connorshea]

Boshen opened an issue for this, so it's good to be worked on now: #15927

Feel free to ping me if you need any help, I'd also like to see these improvements :)

[camc314]

Proposal accepted, being addressed via #15927

[htunnicliff]

Thank you!

I'm going to be offline for the next week due to holidays in the US, but I'll take a crack at this the following week.