Footnotes for titles

[epage]

Ruff added footnote markers to titles for marking which items are fixable

SIM103 [*] Return the condition `bool(a)` directly
 --> SIM103.py:3:5
  |
1 |   def f():
2 |       # SIM103
3 | /     if a:
4 | |         return True
5 | |     else:
6 | |         return False
  | |____________________^
  |
help: Replace with `return bool(a)`
  |
2 |     # SIM103
  -     if a:
  -         return True
  -     else:
  -         return False
3 +     return bool(a)
4 |
  |
note: This is an unsafe fix and may change runtime behavior

(the actual footnote is not included)

Identified in astral-sh/ruff#27033

Fork: astral-sh/ruff#19644

• astral-sh/ruff@1e6e561

[epage]

Alternative: have users change help: to fix:

[epage]

Alternative: have users change help: to fix:

The downside to this is being able to represent this within short messages, either our own or a custom one.

In addition to that, Ruff makes wider use of footnotes and integrates the output in different places, like --summary and --statistics.

[epage]

For Ruff, the footnote is in the Help style. We could

• Use Help
• Use Gutter
• Define a new style
  • If not set, we can either have a hard coded default or default to whatever the user set to one of the above styles
  • The latter is good when splitting a style into two. Here, we are adding a new style so it is likely fine to hard code the default.

I lean towards a new style.