maple-font icon indicating copy to clipboard operation
maple-font copied to clipboard

Published 20 hours ago • verified publisher icon subframe7536

[FeatureReq] Ligature for some comments

Open zaufi opened this issue 8 months ago • 1 comments

There are few "standard" comment admonitions used in code, like

  • ALERT
  • TODO
  • FIXME
  • WARNING
  • ATTENTION
  • NOTE
  • noqa/NOQA

Also, region markers are BEGIN/END. It would be nice to have 'em rendered as [TODO] and others nowadays. A ligature may start w/ the # and/or // symbols (I guess) to catch some popular comment styles.

zaufi avatar Mar 19 '25 10:03 zaufi

I have no plan to add built-in support for various opinioned "tags", but I will provide a easy way to generate them at compile time.

subframe7536 avatar Mar 19 '25 11:03 subframe7536

You can track it in #381

subframe7536 avatar Mar 20 '25 06:03 subframe7536

Hey, I plan to add built-in support for the admonitions you metioned, can you explain the use case and editor support for ALTER, ATTENTION and NOQA ?

subframe7536 avatar Apr 18 '25 07:04 subframe7536

Hey, I plan to add built-in support for the admonitions you metioned, can you explain the use case and editor support for ALTER, ATTENTION and NOQA ?

Here is a typical list of admonitions my fav editor can highlight

zaufi avatar Apr 19 '25 19:04 zaufi

I decide to implement part of them. You can customize it with some python code in next release.

:attention: _noqa_

Image

subframe7536 avatar Apr 20 '25 02:04 subframe7536