composition.pair

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

{captured} is not a valid Canon composition.

Applies in

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

Detection

detector

composition.pair

kind

delegated

Authored examples and fix policies

subtypes

[
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "attempt": {
                "composition_id": "compose.pair",
                "left": "OP",
                "right": "FP"
              },
              "components": [
                {
                  "end": 4,
                  "role": "left",
                  "start": 0
                },
                {
                  "end": 4,
                  "role": "right",
                  "start": 0
                }
              ],
              "kind": "composition-attempt"
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "pair-member-valid",
          "profile": "general-prose",
          "surface": "docs",
          "text": "OPFP"
        }
      ],
      "incorrect": [
        {
          "captured": "OPOP",
          "check_input": {
            "expectation": {
              "attempt": {
                "composition_id": "compose.pair",
                "left": "OP",
                "right": "OP"
              },
              "components": [
                {
                  "end": 4,
                  "role": "left",
                  "start": 0
                },
                {
                  "end": 4,
                  "role": "right",
                  "start": 0
                }
              ],
              "kind": "composition-attempt"
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "pair-repeat-invalid",
          "outcome_id": "violation",
          "profile": "general-prose",
          "surface": "docs",
          "text": "OPOP"
        }
      ]
    },
    "id": "member",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "retry",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "pair-direction-valid",
          "profile": "general-prose",
          "surface": "docs",
          "text": "OPFP"
        }
      ],
      "incorrect": [
        {
          "captured": "FPOP",
          "check_input": {
            "expectation": {
              "attempt": {
                "composition_id": "compose.pair",
                "left": "FP",
                "right": "OP"
              },
              "components": [
                {
                  "end": 4,
                  "role": "left",
                  "start": 0
                },
                {
                  "end": 4,
                  "role": "right",
                  "start": 0
                }
              ],
              "kind": "composition-attempt"
            },
            "kind": "typed-value",
            "node": "notation_token"
          },
          "format": "text",
          "id": "pair-direction-reversed",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "OPFP",
          "surface": "docs",
          "text": "FPOP"
        }
      ]
    },
    "id": "canonical-direction",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "suggest",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  }
]