Skip to content

Draft: [#822] Refactor (out) annotation support

This works, but may need some spit and grit (especially long-winded outdated notes on annotations). Creating early to illustrate some points.

Description

Problem: Jakarta mostly ignores annotations on instructions. We'd like to do the same to simplify our code. However, while we don't want to do much with the annotations, we still need to carry those around because they affect PACK.

Solution: Carry annotations inside typed instructions directly. Create pattern synonyms which ignore annotations to reduce friction. Do not use Notes in HST, use simple singletons instead.

Related issue(s)

Resolves #822 (closed)

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated changelog files of all affected packages released to Hackage if my changes are externally visible.

Stylistic guide (mandatory)

Merge request reports