composition.harmony-reference

Rationale

No separate rationale is authored; the rule statement above is authoritative.

Guidance

No separate guidance is authored. The rule's authored examples and fix policies follow below.

Checker behavior

Message

Store the harmony reference {captured} as {suggested}.

Applies in

• heading
• body
• blockquote
• list item
• table cell
• json key
• glossary term
• notation token

Detection

kind

existence

subjects

• harmony-reference

Authored examples and fix policies

subtypes

[
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "bound_operands": [],
              "composition_id": "compose.harmony-reference",
              "kind": "composition-operand",
              "operand_index": 0
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "harmony-reference-cell",
          "profile": "general-prose",
          "surface": "docs",
          "text": "BE"
        }
      ],
      "incorrect": [
        {
          "captured": "Embrace",
          "check_input": {
            "expectation": {
              "bound_operands": [],
              "composition_id": "compose.harmony-reference",
              "kind": "composition-operand",
              "operand_index": 0
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "harmony-reference-display",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "BE",
          "surface": "docs",
          "text": "Embrace"
        }
      ]
    },
    "id": "stored-address",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "suggest",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  }
]